Metadata-Version: 2.5
Name: galaxalabs_jupyterlab_steel_dark_theme
Version: 1.0.105
Summary: Dark theme based on Sublime text editor default dark theme, tweaked by Stellars
Project-URL: Homepage, https://github.com/stellarshenson/jupyterlab_galaxalabs_steel_dark_theme
Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_galaxalabs_steel_dark_theme/issues
Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_galaxalabs_steel_dark_theme.git
Author-email: Konrad Jelen <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: Framework :: Jupyter :: JupyterLab :: Extensions :: Themes
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

# GalaxaLabs Steel Dark Theme

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

**Dark Gray-blue theme based on Sublime Text Editor**

Dark Sublime Text Editor theme clone for jupyterlab based on [Sublime Text Editor](https://www.sublimetext.com).
This theme has simple, dark gray-blue clean colours and minimal intruision into the standard jupyterlab styling.
Base theme on which this one was built is the original [Jupyterlab Darcula theme](https://github.com/telamonian/theme-darcula)

Project is based on the latest [jupyterlab extension template](https://github.com/jupyterlab/extension-template) and built with with copier.

![](https://github.com/stellarshenson/jupyterlab_galaxalabs_steel_dark_theme/blob/master/screenshot-steel-dark.png?raw=true)

## Theme Colors

Sublime dark theme is based upon a popular **Mariana** theme (default dark theme of Sublime) with some modifications to not make the colors overly contrastive:

## Requirements

- JupyterLab >= 4.6.0

## Install

To install the extension, execute:

```bash
pip install galaxalabs_jupyterlab_steel_dark_theme
```

## Uninstall

To remove the extension, execute:

```bash
pip uninstall galaxalabs_jupyterlab_steel_dark_theme
```

## Contributing

### Development install

Note: You will need NodeJS to build the extension package.

#### Dependencies

- install nodejs with conda: `conda install nodejs`
- install jupyterlab: `conda install jupyterlab`
- install maketools: `conda install make`
- install build and setuptools: `pip install build setuptools`

#### Build

- invoke `make` to build the `.whl` package
- invoke `make clean` to run cleanup & uninstall
- invoke `make install` to build and install extension
- invoke `make uninstall` to uninstall extension

#### Development

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

```bash
# Clone the repo to your local environment
# Change directory to the galaxalabs_jupyterlab_steel_dark_theme directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build
```

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
```

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

```bash
jupyter lab build --minimize=False
```

### Development uninstall

```bash
pip uninstall galaxalabs_jupyterlab_steel_dark_theme
```

In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `@stellarshenson/galaxalabs-jupyterlab-steel-dark-theme` within that folder.

### Packaging the extension

See [RELEASE](RELEASE.md)
