Skip to main content

A dark theme for JupyterLab.

Project description

jupyterlab_darkside_theme

Github Actions Status A dark theme for JupyterLab.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_darkside_theme

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_darkside_theme

Contributing

Development install

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

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 jupyterlab_darkside_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 jupyterlab_darkside_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 jupyterlab_darkside_theme within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

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

jupyterlab_darkside_theme-0.1.2.tar.gz (165.4 kB view details)

Uploaded Source

Built Distribution

jupyterlab_darkside_theme-0.1.2-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_darkside_theme-0.1.2.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_darkside_theme-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6632239197abca5e8ac6d1b58c9dd3c03dcb69ffc39b0bb6b3a1db7d7fa73236
MD5 b2ea504922203b35160a40c100520b71
BLAKE2b-256 e62b400d9c14bcccfb3ae2c55a8767995a0d3bee2ff147de14ca79626f7bf4c8

See more details on using hashes here.

File details

Details for the file jupyterlab_darkside_theme-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_darkside_theme-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fcd47effe862bc873421840c62721e668aeb21a4ef2b0991f3caeadbffec91d2
MD5 8e6e845aa6e9edc60e2faf9e5f14a69a
BLAKE2b-256 27941a9eefe906f8a13f4d654efc97331d1ab4813342ac65abd5f7b648edde83

See more details on using hashes here.

Supported by

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