Metadata-Version: 2.5
Name: jupyterlab_proxy_launcher_command_extension
Version: 1.0.16
Summary: 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-URL: Homepage, https://github.com/stellarshenson/jupyterlab_proxy_launcher_command_extension
Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_proxy_launcher_command_extension/issues
Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_proxy_launcher_command_extension.git
Author-email: Stellars Henson <konrad.jelen@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: jupyter,jupyterlab,jupyterlab-extension
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: jupyter-builder<2,>=1.2.0; extra == 'dev'
Requires-Dist: jupyterlab<5,>=4.6; extra == 'dev'
Description-Content-Type: text/markdown

# jupyterlab_proxy_launcher_command_extension

[![GitHub Actions](https://github.com/stellarshenson/jupyterlab_proxy_launcher_command_extension/actions/workflows/build.yml/badge.svg)](https://github.com/stellarshenson/jupyterlab_proxy_launcher_command_extension/actions/workflows/build.yml)
[![npm version](https://img.shields.io/npm/v/@stellarshenson/jupyterlab-proxy-launcher-command-extension.svg)](https://www.npmjs.com/package/@stellarshenson/jupyterlab-proxy-launcher-command-extension)
[![PyPI version](https://img.shields.io/pypi/v/jupyterlab-proxy-launcher-command-extension.svg)](https://pypi.org/project/jupyterlab-proxy-launcher-command-extension/)
[![Total PyPI downloads](https://static.pepy.tech/badge/jupyterlab-proxy-launcher-command-extension)](https://pepy.tech/project/jupyterlab-proxy-launcher-command-extension)
[![JupyterLab 4](https://img.shields.io/badge/JupyterLab-4-orange.svg)](https://jupyterlab.readthedocs.io/en/stable/)
[![Brought To You By KOLOMOLO](https://img.shields.io/badge/Brought%20To%20You%20By-KOLOMOLO-00ffff?style=flat)](https://kolomolo.com)

> [!TIP]
> This extension is part of the [stellars_jupyterlab_extensions](https://github.com/stellarshenson/stellars_jupyterlab_extensions) metapackage. Install all Stellars extensions at once: `pip install stellars_jupyterlab_extensions`

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.

![](.resources/screenshot-modal.png)

## 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

> Yes, at its core this extension just constructs a URL and opens it. Revolutionary stuff. But somewhere between "I could write this in 5 minutes" and actually having a polished, reusable command with validation, keyboard shortcuts, and proper JupyterLab integration - well, that's where the mass hours went. You're welcome.

## 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:

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

## Launcher Icon

If you're building a custom launcher that uses this extension, feel free to use the included [proxy icon](.resources/proxy.svg).

## Requirements

- JupyterLab >= 4.6.0
- jupyter-server-proxy

## Install

```bash
pip install jupyterlab_proxy_launcher_command_extension
```

## Uninstall

```bash
pip uninstall jupyterlab_proxy_launcher_command_extension
```
