Skip to main content

jupyterlab-proxy-gui

Github Actions Status Binder npm

A JupyterLab extension show endpoins of proxy routes as new tabs. JupyterHub and the configurable-http-proxy is used to forward the data.

A docker setup can be found at examples/docker

proxy-gui-example

This extension is composed of a Python package named jupyterlab_proxy_gui for the server extension and a NPM package named jupyterlab-proxy-gui for the frontend extension.

Requirements

  • JupyterLab >= 3.0
  • JupyterHub

Install

Note: You will need NodeJS to install the extension.

pip install jupyterlab_proxy_gui
jupyter lab build

Troubleshoot

If you are seeing the frontend extension but it is not working, check that the server extension is enabled:

jupyter serverextension list

If the server extension is installed and enabled but you are not seeing the frontend, check the frontend is installed:

jupyter labextension list

If it is installed, try:

jupyter lab clean
jupyter lab build

Contributing

Install

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Move to jupyterlab-proxy-gui directory

# Install server extension
pip install -e .
# Register server extension
jupyter serverextension enable --py jupyterlab_proxy_gui --sys-prefix

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Uninstall

pip uninstall jupyterlab_proxy_gui
jupyter labextension uninstall jupyterlab-proxy-gui

Metadata

Release files for jupyterlab-proxy-gui 0.1.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for jupyterlab-proxy-gui 0.1.16
File Interpreter ABI Platform Actions
jupyterlab_proxy_gui-0.1.16-py3-none-any.whl Python 3 none any Details for jupyterlab_proxy_gui-0.1.16-py3-none-any.whl

Release files / jupyterlab_proxy_gui-0.1.16-py3-none-any.whl

Download URL jupyterlab_proxy_gui-0.1.16-py3-none-any.whl
Size 15.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9c4d36f179fb2c2490196c6ff759e5b8d85736161c516c967318b3bee92c4fcb
BLAKE2b-256 checksum
How to use checksums
1030650e54749dc9924f7d03ba2d9e875be8bb5f3c65eeae24b290be17f370e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.9.12

Security for jupyterlab-proxy-gui 0.1.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page