Metadata-Version: 2.4
Name: jupyterlab_launcher_sections_extension
Version: 1.0.3
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: 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
Requires-Dist: jsonschema>=4.0
Requires-Dist: jupyter-server<3,>=2.4.0
Requires-Dist: pyyaml>=6.0
Provides-Extra: dev
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-jupyter[server]>=0.6.0; 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/jupyterlab_launcher_sections_extension.svg)](https://www.npmjs.com/package/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)

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.0.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
```
