search

emacs-jupyter / jupyter

An interface to communicate with Jupyter kernels.
GNU General Public License v3.0
934 stars 92 forks source link

Increase visibility of the package #535

Open egr95 opened 5 months ago

egr95 commented 5 months ago

Thanks for the package!

It strikes me that emacs-jupyter seems relatively unknown in the wider emacs/python communities, despite providing the best interactive python workflow of any editor that I have worked with (having spent significant time on each of VSCode, PyCharm, JupyterLab, and Neovim). The ability to disentangle python source code and python REPL sessions is a big improvement over the standard jupyter notebook workflow. But emacs-jupyter is unique in that it provides a python REPL that behaves much like a regular buffer. Arguably this provides a superior experience to any other REPL; one consistent set of keybindings everywhere! The closest alternative would be Neovim via some of the below plugins, however these all fall short because they run the python REPLs using the likes of vterm, which unfortunately has its own set of modes/keybindings (not to mention graphics integration becomes a huge headache).

Given the merits of emacs-jupyter, I think it would benefit from being better publicized. In particular, I think a few screenshots or even short videos of a typical python script + REPL workflow would go a long way, and hopefully increase adoption. For example, the following vim packages do a good job of making this functionality clear right away:

I think adding something similar to the README could really catch the eye of users that are interested in this type of interactive python workflow, who might otherwise gloss over this awesome package and get lost in all the other org-related stuff that's also documented in the README (on a related note, Doom emacs only includes emacs-jupyter as an extension of its org module, but not as an extension of its python module, perhaps because there is indeed a lack of awareness of the awesome standalone REPL that emacs-jupyter provides).

nnicandro commented 5 months ago

Thanks for liking the package and for thinking the interactive experience in emacs-jupyter to be superior to those other editors!

I do think that having some GIFs would catch the eye of potential users. I may get to adding them at some point, but it's not that high of a priority for me. I'm glad to accept a PR from anyone who would like to add some.