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
pip install jupyverse[jupyterlab] # for the JupyterLab front-end
# or
pip install jupyverse[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 -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
# you should also install the latest FPS:
pip install git+https://github.com/jupyter-server/fps
# 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.29-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1d9281d47d223b462c6e37f03723f8c2ae53edbfef441c29a62f346991e4d2f |
|
MD5 | 8a7c59f517f462a552421247760e7bb5 |
|
BLAKE2b-256 | a2c143d44d718c8a69b6daaa707ace766fc91585d3b44031deccab0ffba0a68a |