Metadata-Version: 2.4
Name: jupyterlab_proxy_launcher_command_extension
Version: 1.0.14
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: BSD 3-Clause License
        
        Copyright (c) 2026, Stellars Henson
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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: License :: OSI Approved :: BSD License
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
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/jupyterlab_proxy_launcher_command_extension.svg)](https://www.npmjs.com/package/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)

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:

```typescript
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

```bash
pip install jupyterlab_proxy_launcher_command_extension
```

## Uninstall

```bash
pip uninstall jupyterlab_proxy_launcher_command_extension
```
