Euporie is a suite of terminal applications for interacting with Jupyter kernels
Project description
euporie
Euporie is a terminal based interactive computing environment for Jupyter.
Euporie’s apps allow you to interact with Jupyter kernels, and run Jupyter notebooks - entirely from the terminal.
If you’re working with Jupyter notebooks in a terminal only environment, like an SSH server or a container, or just prefer working in the terminal, then euporie is the tool for you!
Install
You can install euporie with pipx (recommended) or pip:
$ pipx install euporie
$ # OR
$ python -m pip install --user euporie
You can also try euporie online here.
Features
Edit and run notebooks in the terminal
Run code interactively in a console
Display images using terminal graphics (sixel / iterm / kitty)
Use Jupyter widgets interactively in the terminal
Render rich kernel output (markdown, tables, images, LaTeX, HTML, SVG, & PDF)
Tab-completion, line suggestions and contextual help
Convert a console session to a notebook
Micro / Vim / Emacs style key-bindings
Usage
Notebooks
You can edit a notebook using euporie-notebook, and passing the notebook’s file path or URI as a command line argument:
$ euporie-notebook notebook.ipynb
Alternatively, launch euporie-notebooks and open a notebook file by selecting “Open” from the file menu (Ctrl+O).
Console
To connect to a Jupyter kernel and run code interactively in a console session, you can run
$ euporie-console
(You can press Ctrl+C to open the command palette in euporie-console).
Preview
To preview a notebook to the terminal, use the euporie-preview subcommand:
$ euporie-preview notebook.ipynb
Hub
To run euporie hub, a multi-user SSH server for euporie apps, run:
$ euporie-hub --port 8022 --host-keys=ssh_host_ed25519_key --client-keys=authorized_keys
where ssh_host_ed25519_key is the path to your host key file, and authorized_keys is a file containing SSH public keys allowed to connect.
Documentation
View the online documentation at: https://euporie.readthedocs.io/
The code is available on GitHub at: https://github.com/joouha/euporie
Compatibility
Euporie requires Python 3.8 or later. It works on Linux, Windows and MacOS
Project details
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.
Source Distribution
Built Distribution
File details
Details for the file euporie-2.8.4.tar.gz
.
File metadata
- Download URL: euporie-2.8.4.tar.gz
- Upload date:
- Size: 337.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7e626781a79158c0f5968d8379a3f7ef9e933c299c6435ccde8c753ec7ae360 |
|
MD5 | e5e00e615cc64698a7e7257ec9191ebc |
|
BLAKE2b-256 | 1f1fd4e03d40e950099a1a4ccdf58f50e657d97da8329928acb867feba28ba74 |
File details
Details for the file euporie-2.8.4-py3-none-any.whl
.
File metadata
- Download URL: euporie-2.8.4-py3-none-any.whl
- Upload date:
- Size: 403.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b42f861f82b078a181fd67bcd64ebd07d7f4efe92feb9887d0d3fec2fd1dacc3 |
|
MD5 | ba08dad7f340f791eb227673881e61c9 |
|
BLAKE2b-256 | eb8ed429c3f5000fc8fb0907651de9c7b72a8121c2e22a88419024ebf9d2a538 |