Overview

Euporie consists of four applications, each providing different functionality:

Euporie Notebook

This is an interactive TUI Jupyter Notebook editor, which runs in the terminal and allows you to view, edit and run Jupyter Notebooks. It makes full use of Jupyter’s rich output system, and is able to render a range of media in the terminal.

Euporie Console

This is a terminal frontend for kernels using the Jupyter protocol, which makes use of euporie’s rich display system for kernel output. It is capable for displaying interactive widgets using ipywidgets. You can convert the history of a console session to a notebook.

Euporie Preview

This allows you to preview notebooks in the terminal without opening them in the editor. The rendered notebook output can be printed to the standard output, piped to a pager, or saved to a file. You can also run notebooks before rendering them.

Euporie Hub

This allows you to run euporie as a multi-user SSH server, meaning that multiple users can share a server’s resources. Each connected user is presented with the euporie editor interface, and can use it to open, run and edit notebooks.


Command Line Interface

In addition to being launched directly, each application in eurporie can be launched by passing its name as an argument to the euporie command.

Usage

$ euporie [-h] [--version] [--log-file [str]]
               [--log-level {debug,info,warning,error,critical}]
               [--log-config str]
               {console,edit,hub,notebook,preview}

Positional Arguments

{console,edit,hub,notebook,preview}

The application to launch

Optional Arguments

-h, --help

show this help message and exit

--version, -V

Show the version number and exit

--log-file <str>

File path for logs

--log-level {debug,info,warning,error,critical}

Set the log level

--log-config <str>

Additional logging configuration