Skip to main content

An FPS plugin implementing a Jupyter server

Project description

Build Status Code style: black Binder

jupyverse

A set of FPS plugins implementing a Jupyter server.

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

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 .[jupyterlab] --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/adriendelsalle/fps

# if you want RetroLab instead of JupyterLab:
# pip install -e .[retrolab] --no-deps
# pip install -e plugins/retrolab
# ...

Usage

Without authentication

jupyverse --open-browser --authenticator.mode=noauth

This will open a browser at http://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 --JupyterLab.collaborative=true

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.7.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

jupyverse-0.0.7-py2.py3-none-any.whl (6.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyverse-0.0.7.tar.gz
Algorithm Hash digest
SHA256 a49a5b0a9e2a180bc49bc8a6a2e09a2575c6234a380967200df584fef8b82d51
MD5 519b9637bd8dd92106fe8a765b22a465
BLAKE2b-256 b48db1a1549b7512a3e526ea5e168435c417530954d64162dc07117c59c6ad45

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for jupyverse-0.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 142824e2fc5fb39fc1648722f5d2f5c0f881a99192f49c914aa408afcf9966e0
MD5 e53a2fd0887eecbc4b4c97ea8ed7019b
BLAKE2b-256 a409032a23b9cbd717130c38970a04fdc86df01a2bb89e5d67e8b93ebf60f525

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