/jupyter-status

Get a quick, tabular summary of running Jupyter servers and kernels.

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Jupyter Status

Get a quick, tabular summary of running Jupyter servers and kernels. Especially useful as a status board when embedded in your desktop using GeekTool, Ubersicht, Conky, or the like.

Blog post: Announcing jupyter-status

Example

Here I have three jupyter lab servers running on my machine, each with a few notebooks or consoles open:

localhost:8888 /Users/bagrow/projects/research-project-01/notebooks
Name                            Type      Kernel               Last active       Status
------------------------------  --------  -------------------  ----------------  --------
Console 1                       console   research-project-01  2020-08-19 22:28  idle
Console 2                       console   research-project-01  2020-08-19 22:28  idle
01-jpb-explore-data.ipynb       notebook  research-project-01  2020-08-19 22:28  idle
jpb-log_2020-08-19.ipynb        notebook  research-project-01  2020-08-19 22:28  idle

localhost:8889 /Users/bagrow/projects/cool-science-playground/notebooks
Name                     Type      Kernel                     Last active       Status
-----------------------  --------  -------------------------  ----------------  --------
Console 1                console   cool-science-playground    2020-08-19 22:28  idle

localhost:8890 /Users/bagrow/projects/research-project-02/notebooks
Name                             Type      Kernel               Last active       Status
-------------------------------  --------  -------------------  ----------------  --------
Console 1                        console   research-project-02  2020-08-16 16:17  idle
01.0-jpb-explore-data.ipynb      notebook  research-project-02  2020-08-16 16:18  idle
02.0-jpb-big-simulation.ipynb    notebook  research-project-02  2020-08-19 22:28  running
jpb-log_2020-08-15.ipynb         notebook  research-project-02  2020-08-16 16:17  idle

I find kernel names are helpful when using per-project environments (in my case, with Anaconda).

Usage

From the command-line, run:

jupyter-status

Or maybe you want an HTML table:

jupyter-status -f html

Arguments to -f are passed to tabulate's tablefmt option.

See jupyter-status -h for full details.

Install

Install with pip:

pip install jupyter-status