Skip to main content

Jupyterlab commands to launch jupyterlab proxy to a given port (modal window) and lauch it either as new jupyterlab tab or new browser tab

Project description

jupyterlab_proxy_launcher_command_extension

GitHub Actions npm version PyPI version Total PyPI downloads JupyterLab 4 Brought To You By KOLOMOLO

JupyterLab extension providing a command to launch jupyter-server-proxy connections via modal dialog, opening proxied services in either a JupyterLab tab or new browser window.

Features

  • Modal dialog - Configure port, path suffix, and target (JupyterLab tab or browser window)
  • JupyterLab tab - Embed proxied service in an IFrame within JupyterLab
  • Browser tab - Open proxied service in a new browser window
  • Command palette - Access via "Open Proxy Launcher" in the Proxy category
  • Keyboard shortcut - Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
  • Programmatic API - Call with arguments to pre-fill dialog values

Usage

  1. Open command palette (Ctrl+Shift+C / Cmd+Shift+C)
  2. Search for "Open Proxy Launcher"
  3. Enter port number and optional path suffix
  4. Choose whether to open in new browser tab
  5. Click "Open"

Command Arguments

When calling the command programmatically, the following arguments are supported:

Argument Type Description
default_port number Pre-fill port input
default_path string Pre-fill path suffix input
default_newBrowserTab boolean Pre-check the browser tab checkbox
title string Custom title for the JupyterLab tab

Example:

app.commands.execute('proxy-launcher:open', {
  default_port: 8501,
  default_path: '/api/docs',
  title: 'Streamlit App'
});

Requirements

  • JupyterLab >= 4.0.0
  • jupyter-server-proxy

Install

pip install jupyterlab_proxy_launcher_command_extension

Uninstall

pip uninstall jupyterlab_proxy_launcher_command_extension

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

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file jupyterlab_proxy_launcher_command_extension-1.0.14.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_proxy_launcher_command_extension-1.0.14.tar.gz
Algorithm Hash digest
SHA256 c6cbf060dac743d8be85aebe314b4ba058939f95565f9b4603bc31e889aa3f23
MD5 2a7a520e7ca81a91ff5612040b210f96
BLAKE2b-256 f5153cd8b8641906386ae0e9faa958ef45b513e25139943f551729e324a64e58

See more details on using hashes here.

File details

Details for the file jupyterlab_proxy_launcher_command_extension-1.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_proxy_launcher_command_extension-1.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 ed31bcda4e56128fb9194edf74737c66e91c53447b5b53b8d17c00284c67897f
MD5 c8f35cd4fbea1f63685aa5523892b3b9
BLAKE2b-256 e35930ac2c83c612cca4c38c2c7a1f2e94235088db20ffdc51fae19a6f39ba59

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page