A set of FPS plugins implementing a Jupyter server
Project description
jupyverse
A set of FPS plugins implementing a Jupyter server.
Try it online:
- JupyterLab frontend:
- RetroLab frontend:
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 or conda (using the conda-forge channel):
mamba install jupyverse fps-jupyterlab # for the JupyterLab front-end
# or
mamba install 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.
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
File details
Details for the file jupyverse-0.0.33.tar.gz.
File metadata
- Download URL: jupyverse-0.0.33.tar.gz
- Upload date:
- Size: 12.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 13fd38d9d16350e05c267c3e7e87a98d9773dfe20aed295926ec5b2ec229ea19 |
|
| MD5 | af708f87ec57347d836c262a922ab393 |
|
| BLAKE2b-256 | b18d27b4bfd12a6aa01ae0590110c801b7dd1cc4ef26c16655a219cdcf3caa83 |
File details
Details for the file jupyverse-0.0.33-py2.py3-none-any.whl.
File metadata
- Download URL: jupyverse-0.0.33-py2.py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e38ab7d80882bc33f59b402f0bb8b0d7bcb99d90f4edb9746f8307aca9d95e65 |
|
| MD5 | 7c09bc4fb38e499daab45e08f9c5b477 |
|
| BLAKE2b-256 | bf1a45cb4e04279c381fa84c9df9842719b1d235d666c43f73f34194328860b5 |
