Install

Jupyverse can be installed to run either JupyterLab or Jupyter Notebook.

With pip

For the JupyterLab frontend:

pip install "jupyverse[jupyterlab,auth]"

Or for the Jupyter Notebook frontend:

pip install "jupyverse[notebook,auth]"

With micromamba

We recommend using micromamba to manage conda-forge environments (see micromamba's installation instructions). First create an environment, here called jupyverse, and activate it:

micromamba create -n jupyverse
micromamba activate jupyverse

Then install Jupyverse and the desired plugins.

For the JupyterLab frontend:

micromamba install -c conda-forge jupyverse fps-jupyterlab fps-auth

Or for the Jupyter Notebook frontend:

micromamba install -c conda-forge jupyverse fps-notebook fps-auth

Development install

You first need to clone the repository:

git clone https://github.com/jupyter-server/jupyverse.git
cd jupyverse

Jupyverse uses uv for project management. Create a virtual environment and install Jupyverse and all plugins:

uv venv
uv pip install --group test -e ".[ \
    jupyterlab, \
    notebook, \
    auth, \
    auth-fief, \
    auth-jupyterhub, \
    noauth, \
    file-watcher-poll, \
    kernel-web-worker, \
    resource-usage, \
    webdav \
]"

Tests should be executed using:

uv run pytest -v

As all the plugins are installed in the same environment, you need to disable some of them in order to start Jupyverse:

uv run jupyverse \
    --disable auth_fief \
    --disable auth_jupyterhub \
    --disable noauth \
    --disable file_watcher_poll \
    --disable notebook