Metadata-Version: 2.4
Name: jupyterlab_vscode_icons_extension
Version: 1.1.57
Summary: Jupyterlab extension with a shameless rip-off of the vscode-icons into our beloved environment
Project-URL: Homepage, https://github.com/stellarshenson/jupyterlab_vscode_icons_extension
Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_vscode_icons_extension/issues
Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_vscode_icons_extension.git
Author-email: Stellars Henson <konrad.jelen@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2025, 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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# JupyterLab VSCode Icons Extension

[![GitHub Actions](https://github.com/stellarshenson/jupyterlab_vscode_icons_extension/actions/workflows/build.yml/badge.svg)](https://github.com/stellarshenson/jupyterlab_vscode_icons_extension/actions/workflows/build.yml)
[![npm version](https://img.shields.io/npm/v/jupyterlab_vscode_icons_extension.svg)](https://www.npmjs.com/package/jupyterlab_vscode_icons_extension)
[![PyPI version](https://img.shields.io/pypi/v/jupyterlab-vscode-icons-extension.svg)](https://pypi.org/project/jupyterlab-vscode-icons-extension/)
[![Total PyPI downloads](https://static.pepy.tech/badge/jupyterlab-vscode-icons-extension)](https://pepy.tech/project/jupyterlab-vscode-icons-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`

A shameless, unapologetic, and utterly brazen ripoff of the excellent VSCode file icons for JupyterLab. Because why should VS Code users have all the fun?

This extension brings 1414 beautiful file type icons from the vscode-icons project directly into your JupyterLab file browser. We saw those pretty icons, we wanted them, and now you can have them too - no permission asked, no apologies given (well, we did use the MIT license, so it's all legally kosher)

## Features

![VSCode Icons in JupyterLab](.resources/screenshot-icons.png)

- 1414 file type icons covering virtually every language, framework, and config file you can think of
- Automatic icon detection based on file extensions and names
- Zero configuration required - just install and enjoy
- Lightweight integration using Iconify's JSON icon format
- Compatible with Jupytext - properly displays Python and Markdown icons for .py and .md notebook files; includes hotfix for jupytext 1.19.1 catch-all pattern bug that breaks standard file icons
- Python package folder detection - folders declared in `pyproject.toml` or `setup.py` get a special Python package icon

## Requirements

- JupyterLab 4.0+
- A sense of humor about intellectual property (kidding - it's MIT licensed)
- Appreciation for pretty icons

## Installation

```bash
pip install jupyterlab_vscode_icons_extension
```

That's it. Restart JupyterLab and watch your bland, iconless file browser transform into a colorful, VSCode-inspired masterpiece

## Supported File Types

The extension recognizes hundreds of file types including:

- **Languages**: Python, JavaScript, TypeScript, Java, C/C++, Rust, Go, Ruby, PHP, R, Julia, and many more
- **Web**: HTML, CSS, SCSS, Vue, Svelte, React components
- **Data**: JSON, YAML, CSV, XML, TOML
- **Documentation**: Markdown, RST, PDF
- **Config**: Dockerfile, .gitignore, .env, Makefile, package.json
- **Notebooks**: Jupyter notebooks (.ipynb)

For the complete list of 1414 icons, see the [vscode-icons project](https://github.com/vscode-icons/vscode-icons)

## Configuration

Customize which icon groups to display via JupyterLab Settings:

1. Open JupyterLab Settings (Settings -> Settings Editor)
2. Search for "VSCode Icons"
3. Toggle icon groups on/off:
   - Programming Language Icons (Python, JS, TS, Java, C++, Rust, Go, etc.)
   - Web Development Icons (HTML, CSS, Vue, Svelte)
   - Data Format Icons (JSON, YAML, CSV, XML)
   - Configuration File Icons (Dockerfile, .gitignore, Makefile, package.json)
   - Documentation Icons (Markdown, RST, PDF)
   - Image File Icons (PNG, JPG, SVG)

Changes require a page refresh to take effect.

## Uninstallation

If you somehow tire of beautiful icons (we can't imagine why):

```bash
pip uninstall jupyterlab_vscode_icons_extension
```

## Credits

This extension shamelessly borrows icons from the excellent [vscode-icons](https://github.com/vscode-icons/vscode-icons) project by Roberto Huertas. Icons are delivered via [Iconify](https://iconify.design/), because we believe in standing on the shoulders of giants.

All icon assets remain under their original licenses (MIT for code, CC BY-SA for branded icons). We just wrapped them in a JupyterLab extension and called it a day.

**Custom Icons**: A few icons (Python, Markdown, README) were hand-crafted in Inkscape - because sometimes you need that perfect shade of purple and the exact right amount of snake eyes.

## Why This Exists

Because JupyterLab deserves pretty icons too. That's it. That's the whole justification
