Skip to content

joouha/euporie

 
 

Repository files navigation

<Logo>

euporie

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

Euporie is a terminal app for running and editing Jupyter notebooks.

The text-based interface is inspired by JupyterLab / Jupyter Notebook, and runs entirely in the terminal.


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.

Usage

Open a notebook using the edit subcommand and passing the notebook's file path as a command line argument:

$ euporie edit notebook.ipynb

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

To print a notebook to the terminal, use the preview subcommand:

$ euporie preview notebook.ipynb

To view a notebook in the system pager, use the --page flag:

$ euporie preview --page notebook.ipynb

For more information about the available subcommands and command line flags, run:

$ euporie --help

Documentation

View the online documentation at: https://euporie.readthedocs.io/

The code is available on GitHub at: https://github.com/joouha/euporie

Features

  • Edit and run notebooks in the terminal
  • Displays rich cell outputs, including markdown, tables, images, LaTeX, HTML, SVG, & PDF
  • Print formatted notebooks to the terminal or pager
  • Open multiple notebooks and display them stacked or tiled
  • Code completion
  • Line completions from history
  • Contextual help
  • Automatic code formatting
  • Highly configurable

Compatibility

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