mypython icon indicating copy to clipboard operation
mypython copied to clipboard

Add some pictures or video clips to your Readme

Open eabase opened this issue 2 years ago • 1 comments

There are many REPL replacements and fixers out there, so it would be incredibly more helpful if you could add some screenshots, video clips or dynamic gifs on how this looks and how it's better than others.

Perhaps, more specifically, what are you adding or improving here, that is not already in ipython or bpython ones?

Cheers!

eabase avatar Jan 20 '22 19:01 eabase

So far I've basically just been writing this project for me. I use it every day, but I've never written it with one person in mind. This simplifies the design quite a bit as I don't have to worry about configuration or anything like that. You'll also notice that there isn't a setup.py and it isn't in any package manager. I myself just run it directly from the git repo.

I might consider making this something that other people can use, but only if there is genuine interest. If you want to know what this is like, I would suggest just trying it. You can install the dependencies from requirements.txt and start it with ./bin/mypython after cloning the repo.

The README lists all the main features. It's kind of hard to show off things with a picture or video. The most obvious "feature" you would see in a screenshot is the stupid emoji prompts, but those are just a meme, and not really that essential. The main features are things like multiline input and syntax highlighting, but that comes from prompt-toolkit so will be supported equally well by something like IPython. The other main things are default key bindings which I consider to be sane (impossible to show in a screenshot), syntactically correct tokenization for things like parentheses matching (e.g., not treating "(") as a matching pair like IPython does), and a select number of features like ? and a few %magic commands borrowed from IPython, but working in a way that I consider to be clean.

Making this work for other people would entail adding customization and extensibility (which would add a lot of complexity to the code), probably changing a few of the defaults, and adding several features that I don't care about but other people might care about (like some of the IPython %magic commands that I never use). Plus standard maintenance stuff that I've ignored, like packaging, doing releases, making changes to PRs instead of committing directly to master, using the issue tracker, adding documentation, and so on.

I am open to this, but really only if there is someone who is interested in not only using it, but contributing to it as well, as that's the only way I could sustain the extra maintenance burden from the extra complexity. Otherwise, I'm happy with the README just listing the features and explaining what this is. I will always keep it open source, but I'm not really going to advertise it as something that people should use, as that would just be false advertising.

asmeurer avatar Jan 20 '22 20:01 asmeurer