Euporie Save

Jupyter notebooks in the terminal

Project README


.. |logo| image:: :alt: <Logo>

####### euporie #######

|PyPI| |RTD| |PyVer| |License| |Binder| |Stars|

.. content_start

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.

.. list-table:: :align: center :widths: 25 25 25 25 :class: text-center

    • Console <>_
    • Notebook <>_
    • Preview <>_
    • Hub <>_

.. image:: :target:

View more screenshots here <>_


You can install euporie with pipx <>_ (recommended) or pip:

.. code-block:: console

$ pipx install euporie $ # OR $ python -m pip install --user euporie

You can also try euporie online here <>_.


  • 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



You can edit a notebook using euporie-notebook, and passing the notebook's file path or URI as a command line argument:

.. code-block:: console

  $ euporie-notebook notebook.ipynb

Alternatively, launch euporie-notebooks and open a notebook file by selecting "Open" from the file menu (Ctrl+O).


To connect to a Jupyter kernel and run code interactively in a console session, you can run

.. code-block:: console

  $ euporie-console

(You can press Ctrl+C to open the command palette in euporie-console).


To preview a notebook to the terminal, use the euporie-preview subcommand:

.. code-block:: console

  $ euporie-preview notebook.ipynb


To run euporie hub, a multi-user SSH server for euporie apps, run:

.. code-block:: console

  $ 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.


View the online documentation at: <>_

The code is available on GitHub at: <>_


Euporie requires Python 3.8 or later. It works on Linux, Windows and MacOS

.. |PyPI| image:: :target: :alt: Latest Version

.. |RTD| image:: :target: :alt: Documentation

.. |PyVer| image:: :target: :alt: Supported Python versions

.. |Binder| image:: :target: :alt: Launch with Binder

.. |License| image:: :target: :alt: View license

.. |Stars| image:: :target: :alt: ⭐

Open Source Agenda is not affiliated with "Euporie" Project. README Source: joouha/euporie

Open Source Agenda Badge

Open Source Agenda Rating