See the source code. It's a good real-world example of how to use prompt_toolkit to create a non-trivial TUI application.<p><a href="https://python-prompt-toolkit.readthedocs.io/en/master/" rel="nofollow">https://python-prompt-toolkit.readthedocs.io/en/master/</a>
Worth noting that Jupyter themselves announced[1] 'nbterm'[2] recently, which seems like an attempt at the same thing but it seems very very immature compared to Euporie.<p>I don't understand why they announced nbterm at such an early stage tbh. When I tried it it was basically non-working.<p>[1] <a href="https://blog.jupyter.org/nbterm-jupyter-notebooks-in-the-terminal-6a2b55d08b70" rel="nofollow">https://blog.jupyter.org/nbterm-jupyter-notebooks-in-the-ter...</a><p>[2] <a href="https://github.com/davidbrochart/nbterm" rel="nofollow">https://github.com/davidbrochart/nbterm</a><p>Edit: cool to see another project supporting kitty terminal's graphics protocol. kitty is a great terminal and has a lot of good ideas. Also, nice to see Euporie has a section on related projects that mentions nbterm.
Now that's an example of a good README. All the practical information you could want, and a screenshot.<p>(Also, clever name! I'd heard of that particular Greek deity from somewhere else, but never knew she had a moon named after her =])
Looks cool!<p>Random note: the best way to support keystrokes such as Ctrl-Enter and Shift-Enter in the terminal is CSI-u mode:<p><a href="http://www.leonerd.org.uk/hacks/fixterms/" rel="nofollow">http://www.leonerd.org.uk/hacks/fixterms/</a><p>It's supported by most terminals by now.
It's pretty funny how we went<p>- from IPython (a better, notebook-style Python interpreter shell)<p>- to IPython notebooks (IPython, but in a browser)<p>- to Jupyter Notebooks (IPy notebooks, but more backends)<p>- to Euporie, a text interface to Jupyter notebooks<p>Of course this does <i>way</i> more than IPython ever did, or even should do. But it's a pretty funny trajectory, everything old is new again.
TUI already has a far more established technical meaning.
From www.yourdictionary.com:<p>TUI =<p>(Telephone User Interface) The combination of Touch-tone input from the telephone keypad coupled with speech output from the connected voicemail or IVR application. While early speech technology was struggling to recognize voice utterances for voice control and data entry, the ubiquitous Touch-tone keypad was a practical solution. It works with enterprise telephone networks, the PSTN, public payphones and traditional cellphones. Its centerpiece is the standard 12-key keypad and conventions such as using the pound key for "enter," the star key for "up one level" or "escape," and "1" for yes, "2" for no.<p>Using this abbreviation for new uses can only reduce readability.