Metadata-Version: 2.5
Name: jupyterlab_launcher_sections_extension
Version: 1.0.8
Summary: Jupyterlab extension to allow setting section-specific icons for the launcher
Project-URL: Homepage, https://github.com/stellarshenson/jupyterlab_launcher_sections_extension
Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_launcher_sections_extension/issues
Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_launcher_sections_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
Requires-Dist: jsonschema<5,>=4.26
Requires-Dist: jupyter-server<3,>=2.21
Requires-Dist: pyyaml<7,>=6.0
Provides-Extra: dev
Requires-Dist: jupyter-builder<2,>=1.2.0; extra == 'dev'
Requires-Dist: jupyterlab<5,>=4.6; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage<8,>=7.16; extra == 'test'
Requires-Dist: pytest-asyncio<2,>=1.4; extra == 'test'
Requires-Dist: pytest-cov<8,>=7.1; extra == 'test'
Requires-Dist: pytest-jupyter[server]<1,>=0.11; extra == 'test'
Requires-Dist: pytest<10,>=9.2; extra == 'test'
Description-Content-Type: text/markdown

# jupyterlab_launcher_sections_extension

[![GitHub Actions](https://github.com/stellarshenson/jupyterlab_launcher_sections_extension/actions/workflows/build.yml/badge.svg)](https://github.com/stellarshenson/jupyterlab_launcher_sections_extension/actions/workflows/build.yml)
[![npm version](https://img.shields.io/npm/v/@stellarshenson/jupyterlab-launcher-sections-extension.svg)](https://www.npmjs.com/package/@stellarshenson/jupyterlab-launcher-sections-extension)
[![PyPI version](https://img.shields.io/pypi/v/jupyterlab-launcher-sections-extension.svg)](https://pypi.org/project/jupyterlab-launcher-sections-extension/)
[![Total PyPI downloads](https://static.pepy.tech/badge/jupyterlab-launcher-sections-extension)](https://pepy.tech/project/jupyterlab-launcher-sections-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)
[![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-blue?style=flat)](https://www.paypal.com/donate/?hosted_button_id=B4KPBJDLLXTSA)

> [!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`

Customize your JupyterLab launcher with section-specific icons. This extension allows you to set custom icons for different launcher sections, making it easier to visually distinguish between categories of notebooks and other items.

![JupyterLab Launcher with Custom Section Icons](.resources/screenshot.png)

## Features

- **Custom section icons** - Set unique icons for each launcher section (Notebooks, Console, Other, etc.)
- **Server-side configuration** - Configure icons through Jupyter server settings
- **Visual organization** - Improve launcher usability with distinctive section markers

## Requirements

- JupyterLab >= 4.6.0

## Installation

```bash
pip install jupyterlab_launcher_sections_extension
```

For development installation, use:

```bash
make install
```

## Configuration

Create YAML configuration files in `{jupyter_data_dir}/jupyter_launcher_sections/` directory. Each file can contain one or more section configurations.

**Example** (`services.yml`):

```yaml
- section: 'Services'
  icon: 'services.svg'
  tooltip: 'Supporting services for data science and environment management'

- section: 'Notebook'
  icon: 'notebook-custom.svg'
  tooltip: 'Create a new Jupyter Notebook'
```

**Configuration options**:

- `section` (required) - Name of the launcher section to customize
- `icon` (optional) - Path to SVG icon file (relative to config directory or absolute)
- `tooltip` (optional) - Tooltip text shown on hover

Place SVG icon files in the same directory as the YAML configuration or specify absolute paths.

## Uninstall

```bash
pip uninstall jupyterlab_launcher_sections_extension
```
