Euporie is a text-based user interface for running and editing Jupyter notebooks
Project description
euporie
About
Euporie is a text-based user interface for running and editing Jupyter notebooks.
Install
Euporie is on pypi, so can be installed using pip:
pip install euporie
If you are using Windows, you may wish to install some optional python dependencies to render images and HTML tables:
pip install euporie[html-mtable,images-timg]
Screenshots
Usage
To open a notebook file, pass the file name as a command line parameter:
euporie ~/my-notebook.ipynb
Features
- Execute notebooks in the terminal
- Autocompletion in code cells
- Rich output support, including:
- Markdown
- Tables
- Images
- Open multiple notebooks side-by-side
- Good performance with large notebook files
Image Support
Euporie will attempt to render images in the best possible way it can. The following methods are supported:
-
Sixel
If supported by your terminal, euporie can show graphical images in cell outputs This requires one of the following:
-
Kitty's terminal image protocol
If your terminal supports kitty's terminal graphics protocol, euporie will use it to render images
-
Ansi art
This requires one of the following:
The kitty & sixel image rendering methods will fall back to ansi art images when rendering images in partially obscured cells, to prevent clipped images destroying the user interface.
For SVG support, cairosvg or imagemagik are required.
HTML Support
Euporie will attempt to render HTML outputs. This requires one of the following:
Note: only HTML tables will be displayed if mtable is used
If none of these commands are found in your $PATH, the plain text representation will be used.
Key Bindings
| Key Binding | Command |
|---|---|
| Application | |
ctrl-n |
Create a new notebook file |
ctrl-o |
Open file |
ctrl-w |
Close the current file |
ctrl-q |
Quit euporie |
ctrl-s |
Save current file |
| Navigation | |
tab |
Focus next element |
shift-tab |
Focus previous element |
[ |
Scroll up |
] |
Scroll down |
ctrl-up / home |
Go to first cell |
pageup |
Go up 5 cells |
up / k |
Go up one cell |
down / j |
Go down one cell |
pagedown |
Go down 5 cells |
ctrl-down / end |
Go to last cell |
| Notebook | |
a |
Add new cell above |
b |
Add new cell below |
d d |
Delete current cell |
x |
Cut current cell |
c |
Copy current cell |
v |
Paste copied cell |
m |
Change cell to markdown |
y |
Change cell to code |
r |
Change cell to raw |
l |
Toggle line numbers |
e |
Edit cell in $EDITOR |
enter |
Enter cell edit mode |
escape |
Exit cell edit mode |
escape escape |
Exit cell edit mode quickly |
ctrl-enter / ctrl-r |
Run cell |
shift-enter |
Run then select next cell |
| Edit Mode | |
ctrl-f |
Find |
ctrl-g |
Find Next |
ctrl-z |
Undo |
ctrl-d |
Duplicate line |
tab |
Indent |
shift-tab |
Unindent |
ctrl-c |
Copy |
ctrl-x |
Cut |
ctrl-v |
Paste |
* There is a slight delay detecting an escape key-event. To exit edit mode quickly, double-press the escape key.
** These entries require your terminal to support CSI-u mode. If your terminal does not support this, it may be possible to work around this by remapping the keys in your terminal emulator - see below).
When in edit mode, emacs style key-bindings apply.
Key Remapping
By default, VT100 terminal emulators do not distinguish between Enter, Ctrl + Enter & Shift + Enter. In order to work around this, it is possible to re-map these key bindings so they produce the escape code of another key. To replicate the Ctrl + Enter & Shift + Enter of Jupyter, you will need to remap the following shortcuts in your terminal:
| Key Combination | Output |
|---|---|
Ctrl + Enter |
Ctrl + F20 |
Shift + Enter |
F21 |
xterm
Add the following to your ~/.Xresources
*.vt100.translations: #override \n\
Ctrl <Key>Return: string("\033\[19;6~") \n\
Shift <Key>Return: string("\033\[20;2~") \n\
konsole
In the menu, navigate to:
Settings -> Edit Current Profile -> Keyboard -> Edit
Change the existing entry for Return+Shift to Return+Shift+Ctrl (or whatever you prefer), then add the following entries:
| Key combination | Output |
|---|---|
Return+Ctrl |
\E\[19;6~ |
Return+Shift |
\E\[20;2~ |
Roadmap
- Add ability to dump formatted notebooks
- Add command line argument parsing
- Render outputs asynchronously in a separate thread
- Upstream markdown tables in
rich - Cell attachments
- LaTeX
- Widgets
Related projects
-
https://github.com/davidbrochart/nbterm
An alternative effort sponsored by QuantStack
-
https://github.com/chentau/nbtui
A cli Jupyter notebook viewer with support for kitty's terminal graphics protocol
-
https://github.com/mosiman/jupytui
A cli Jupyter notebook viewer
-
https://kracekumar.com/post/jut/
Another cli Jupyter notebook viewer
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
