Skip to main content

A JupyterLab extension theme as vscode onedark

Project description

jupyterlab_extension_theme_onedark

Github Actions StatusBinder A JupyterLab extension theme as vscode onedark

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_extension_theme_onedark

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_extension_theme_onedark

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_extension_theme_onedark 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_extension_theme_onedark

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-extension-theme-onedark 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_extension_theme_onedark-0.1.0.tar.gz (150.7 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file jupyterlab_extension_theme_onedark-0.1.0.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_extension_theme_onedark-0.1.0.tar.gz
Algorithm Hash digest
SHA256 01dd142ab517f82833bfce4cec01e928ab4bd709b6a1c735ff7ed27f0076182b
MD5 01bfe2560356365ae3c0223535c16e28
BLAKE2b-256 ac51ec68c128d54face939730755104cdf3b3ef1f962010c20afbdf335d566b3

See more details on using hashes here.

File details

Details for the file jupyterlab_extension_theme_onedark-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_extension_theme_onedark-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6bc9dd196b61dea80873ffe539be0bb1a2ba500c9daab75419bd715958f2defc
MD5 1aac5ae133e716fb1accf37f5c0c1079
BLAKE2b-256 b00e49836927cbe0a43b9c2c596a082c8e89234289a62eda20882224d132be49

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