Skip to main content

Euporie is a suite of terminal applications for interacting with Jupyter kernels

Project description

<Logo>

euporie

Latest Version Documentation Supported Python versions View license Launch with Binder ⭐

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.

Console

Notebook

Preview

Hub

https://user-images.githubusercontent.com/12154190/182201621-9c3e4b04-1b1e-46e3-b852-b43f16adfc7b.png

View more screenshots here


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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

euporie-2.0.8.tar.gz (229.8 kB view hashes)

Uploaded Source

Built Distribution

euporie-2.0.8-py3-none-any.whl (268.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page