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

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.

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

Uploaded Source

Built Distribution

jupyter_server_proxy-1.6.0-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter-server-proxy-1.6.0.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

File hashes

Hashes for jupyter-server-proxy-1.6.0.tar.gz
Algorithm Hash digest
SHA256 5e08d66a262b069122c029102f6db8e307e9d0fafa05d95aab1ab7ea2df7b169
MD5 d54959d36727df7712ec8626884fcaa1
BLAKE2b-256 58444ccbe5015a3a07f9653a117435a07db2d37374186aaf43f2ac99686dbacc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_server_proxy-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

File hashes

Hashes for jupyter_server_proxy-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 73607a43a5f82baa17a2030b5284b2ee7118c0d6eb4cafbab48552a60a4b5b42
MD5 5c004a6db05b8a9e703086679b8fdcb7
BLAKE2b-256 f1190b68fdfb2179a217fe48a6da25936920726637c21bd97608bc60ef749c6a

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