A set of FPS plugins implementing a Jupyter server
Project description
jupyverse
A set of FPS plugins implementing a Jupyter server.
Try it online:
Motivation
For the motivations behind this project, please refer to this issue in the Jupyter server team compass.
Install
With pip
:
pip install "jupyverse[jupyterlab]" # for the JupyterLab front-end
# or
pip install "jupyverse[retrolab]" # for the RetroLab front-end
With mamba
:
mamba install -c conda-forge jupyverse fps-jupyterlab # for the JupyterLab front-end
# or
mamba install -c conda-forge jupyverse fps-retrolab # for the RetroLab front-end
Note: you cannot have both the JupyterLab and the RetroLab front-ends enabled at the same time.
When switching e.g. from the JupyterLab to the RetroLab front-end, you need to
pip uninstall fps-jupyterlab
or launch Jupyverse with --JupyterLab.enabled=false
.
Development install
Clone this repository and install the needed plugins:
pip install fps[uvicorn]
pip install -e . --no-deps
pip install -e plugins/jupyterlab
pip install -e plugins/login
pip install -e plugins/auth
pip install -e plugins/contents
pip install -e plugins/kernels
pip install -e plugins/terminals
pip install -e plugins/lab
pip install -e plugins/nbconvert
pip install -e plugins/yjs
# if you want RetroLab instead of JupyterLab:
# pip install -e . --no-deps
# pip install -e plugins/retrolab
# ...
Usage
Without authentication
jupyverse --open-browser --authenticator.mode=noauth
This will open a browser at 127.0.0.1:8000 by default, and load the JupyterLab front-end. You have full access to the API, without restriction.
With token authentication
jupyverse --open-browser --authenticator.mode=token
This is the default mode, and it corresponds to Jupyter Server's token-based authentication.
With user authentication
jupyverse --open-browser --authenticator.mode=user
We provide a JupyterLab extension for authentication, that you can install with:
pip install git+https://github.com/davidbrochart/jupyverse-auth
You can currently authenticate as an anonymous user, or using a GitHub account.
With collaborative editing
jupyverse --open-browser --authenticator.collaborative
This is especially interesting if you are "user-authenticated", since your will appear as the identity you chose for authentication.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyverse-0.0.35-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d54be094130449de0a3fb22bac17f27308dd1186c294261b8e7b9e7412fc45a |
|
MD5 | a300b0cfc9cfed6732fb878ed8f77e9f |
|
BLAKE2b-256 | 8c8b171a3d08ea69491a00356a19676ad2988ce4a4d00b265184541d9f2fecd4 |