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 Total PyPI downloads JL4 Ready

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.80.tar.gz (417.7 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.80.tar.gz.

File metadata

File hashes

Hashes for stellars_jupyterlab_sublime_theme-1.0.80.tar.gz
Algorithm Hash digest
SHA256 c4c270b34f388cb6c03fa6e0c2183a861a7a96810422841ce6059f8684447331
MD5 a7d241c52db5e32acc2851fd6e088128
BLAKE2b-256 2955a25fda7c2e717931aaafab6cd746db863523e69160a8091fe20a1305235b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stellars_jupyterlab_sublime_theme-1.0.80-py3-none-any.whl
Algorithm Hash digest
SHA256 e2f37c396e6153e83a73b1bd636438fe08378c2a3ccc8ac8f22102c18ca536c2
MD5 00c3c3195474928471fc48afb065e6a7
BLAKE2b-256 a8c39a6c2853fb83f676f7f17abcf2dc4cbe96550b152f180f1b8e4595068921

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