Skip to main content

A set of FPS plugins implementing a Jupyter server

Project description

Build Status Code style: black

jupyverse

jupyverse is experimental and should not be used in place of jupyter-server, which is the official Jupyter server.

A set of FPS plugins implementing a Jupyter server.

Try it online:

  • JupyterLab frontend: Binder
  • RetroLab frontend: Binder

Motivation for Experimental Server

For the motivations behind this project, please refer to this issue in the Jupyter server team compass.

Install

pip install jupyverse[jupyterlab]

Note: at this stage of development, it is preferable to install from sources (see below).

Development install

Clone this repository and install the needed plugins:

pip install -e . --no-deps
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/jupyterlab
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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyverse-0.0.19.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

jupyverse-0.0.19-py2.py3-none-any.whl (7.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file jupyverse-0.0.19.tar.gz.

File metadata

  • Download URL: jupyverse-0.0.19.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for jupyverse-0.0.19.tar.gz
Algorithm Hash digest
SHA256 b721a455791a4ef4974261b8e609e41170cb578077f8fe114c546a8b5d8a0012
MD5 174bd35ed594d25622da4183fc5e7f78
BLAKE2b-256 8b680809b45774b5a0eb0a85734199ac4954ee0f315e9543fccd0149d093d94e

See more details on using hashes here.

File details

Details for the file jupyverse-0.0.19-py2.py3-none-any.whl.

File metadata

  • Download URL: jupyverse-0.0.19-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for jupyverse-0.0.19-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b0df38be02be5022156336b087990f9ddbb3ee0debde6dd05a83ecb23f5930f6
MD5 48056a52830f746cd42813b80dd6150d
BLAKE2b-256 f1315b6ca8c1e1e3b52413c3cb7aaf66575b65bb18122b1a76d1719a47633844

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page