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/jupyterlab
pip install -e plugins/contents
pip install -e plugins/kernels
pip install -e plugins/terminals
pip install -e plugins/nbconvert
pip install -e plugins/yjs
pip install -e plugins/auth

# 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 --Lab.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.13.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

jupyverse-0.0.13-py2.py3-none-any.whl (7.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: jupyverse-0.0.13.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 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.13.tar.gz
Algorithm Hash digest
SHA256 5b9dc3a38afddaca2045976935e3b87a40845614272983d2464e43d361e9a4c6
MD5 7e1859e0bd474a93d225a379d5cd33ee
BLAKE2b-256 b8db79e38fb6f72fa0f316c8b6bc9161ffae8e5dc938acb8d72ac387fd2136e4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyverse-0.0.13-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 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.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 55aa0bf7577e197ba59af45c7c96e1f3c578bb153ee1d18de2ca83b22d97b182
MD5 41166027e33ad8a6bb1a543be6871de3
BLAKE2b-256 5a4351e9d09dcb2171985dd872bebfdb3c83482aeb7b9c7e3434a5c9138d2266

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