jpterm

jpterm aims to be the equivalent of JupyterLab in the terminal.

It can work either locally, or remotely through a Jupyter server.

Installation

pip install jpterm
# you probably want a (Python) Jupyter kernel too:
pip install ipykernel

Usage

To run jpterm without a server:

jpterm

To run jpterm as a client to a Jupyter server, you need, well, jupyter-server :) You can install it through JupyterLab:

pip install "jupyterlab>=4"
pip install jupyter-collaboration

Then launch it with:

jupyter lab --port=8000 --no-browser

# it will print a URL like: http://127.0.0.1:8000/lab?token=972cbd440db4b35581b25f90c0a88e3a1095534e18251ca8
# you will need the token when launching jpterm, but if you don't want to bother with authentication:
# jupyter lab --port=8000 --no-browser --ServerApp.token='' --ServerApp.password=''

Then launch jpterm in another terminal:

jpterm --server http://127.0.0.1:8000/?token=972cbd440db4b35581b25f90c0a88e3a1095534e18251ca8

# if you launched JupyterLab without authentication:
# jpterm --server http://127.0.0.1:8000

If jpterm is launched with --collaborative, you can open a document in JupyterLab (go to http://127.0.0.1:8000 in your browser), modify it, and see the changes live in jpterm. This also works the other way around.

Development install

jpterm uses hatch:

pip install hatch

To run a command, you need to point hatch to the dev environment, e.g. hatch run dev:jpterm.