Skip to main content

Dark theme based on Sublime text editor default dark theme, tweaked by Stellars

Project description

Stellars Jupyterlab Sublime Theme

GitHub Actions npm version PyPI version PyPI downloads

Dark Gray-blue theme based on Sublime Text Editor

Dark Sublime Text Editor theme clone for jupyterlab based on Sublime Text Editor. 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

Project is based on the latest jupyterlab extension template and built with with copier.

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.0.0

Install

To install the extension, execute:

pip install stellars_jupyterlab_sublime_theme

Uninstall

To remove the extension, execute:

pip uninstall stellars_jupyterlab_sublime_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 that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the stellars_jupyterlab_sublime_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.

# 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:

jupyter lab build --minimize=False

Development uninstall

pip uninstall stellars_jupyterlab_sublime_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 @stellars/jupyterlab_sublime_theme within that folder.

Packaging the extension

See RELEASE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stellars_jupyterlab_sublime_theme-1.0.64.tar.gz (269.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file stellars_jupyterlab_sublime_theme-1.0.64.tar.gz.

File metadata

File hashes

Hashes for stellars_jupyterlab_sublime_theme-1.0.64.tar.gz
Algorithm Hash digest
SHA256 8a471145c7faa44b13bc13f6cc1bd5dd46493960792275775d29b87c8d27bb0f
MD5 4c6260ad58a048b4a1282bc4c92b8638
BLAKE2b-256 60710727d2cf0e7cf5015f39c0bfc4ba3cdb244934cc1f71b32757d57e31f2dd

See more details on using hashes here.

File details

Details for the file stellars_jupyterlab_sublime_theme-1.0.64-py3-none-any.whl.

File metadata

File hashes

Hashes for stellars_jupyterlab_sublime_theme-1.0.64-py3-none-any.whl
Algorithm Hash digest
SHA256 4d749b8946e6fd74016bb4225e970ffd8701e610187469bf25f24ba4898019c6
MD5 4def0ff33818c0248420cdc161b3cc60
BLAKE2b-256 051a2fe74f0c97041ad0385d6da9c49d3fcb5f341af599df12f79c1bfecb9047

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page