Skip to main content

Jupyter server extension to supervise and proxy web services

Project description

Jupyter Server Proxy

ReadTheDocs badge GitHub Workflow Status PyPI badge Conda badge NPM badge

Jupyter Server Proxy lets you run arbitrary external processes (such as RStudio, Shiny Server, Syncthing, PostgreSQL, Code Server, etc) alongside your notebook server and provide authenticated web access to them using a path like /rstudio next to others like /lab. Alongside the python package that provides the main functionality, the JupyterLab extension (@jupyterlab/server-proxy) provides buttons in the JupyterLab launcher window to get to RStudio for example.

Note: This project used to be called nbserverproxy. As nbserverproxy is an older version of jupyter-server-proxy, uninstall nbserverproxy before installing jupyter-server-proxy to avoid conflicts.

The primary use cases are:

  1. Use with JupyterHub / Binder to allow launching users into web interfaces that have nothing to do with Jupyter - such as RStudio, Shiny, or OpenRefine.
  2. Allow access from frontend javascript (in classic notebook or JupyterLab extensions) to access web APIs of other processes running locally in a safe manner. This is used by the JupyterLab extension for dask.

The documentation contains information on installation & usage.

Install

Requirements

  • jupyterlab>=2 or notebook

Python package

pip

pip install jupyter-server-proxy

conda

conda install jupyter-server-proxy -c conda-forge

JupyterLab extension

Note that as the JupyterLab extension only is a graphical interface to launch registered applications in the python package, the extension requires the python package to be installed.

As of version 3.0.0 the Python package ships with a JupyterLab 3 compatible extension, making this step only needed for JupyterLab 2.

jupyter labextension install @jupyterlab/server-proxy

Local development

See [CONTRIBUTING.md].

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

jupyter-server-proxy-3.0.2.tar.gz (43.3 MB view details)

Uploaded Source

Built Distribution

jupyter_server_proxy-3.0.2-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

Details for the file jupyter-server-proxy-3.0.2.tar.gz.

File metadata

  • Download URL: jupyter-server-proxy-3.0.2.tar.gz
  • Upload date:
  • Size: 43.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.9 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for jupyter-server-proxy-3.0.2.tar.gz
Algorithm Hash digest
SHA256 970494e95ad7e5ff6766871ac34378f4dddef3161818e55b52e3607ef691f46d
MD5 1258664cd2e3890dd78ac38d04fb0c67
BLAKE2b-256 87ee986ca24bcd4faaae09d50791042eed774c4823d5eabe5051f1a22e66b934

See more details on using hashes here.

File details

Details for the file jupyter_server_proxy-3.0.2-py3-none-any.whl.

File metadata

  • Download URL: jupyter_server_proxy-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 35.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.9 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for jupyter_server_proxy-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 330592188a0a7c2e0e5e90ba7a7560d01607b47a162d9ad1e39194859cc8808a
MD5 7b1b03609bb8e305415786f6249449b5
BLAKE2b-256 3850a461c8346d36c266ee37678b4a21277139ba953476204bc5bdcf14987773

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