Skip to main content

A JupyterLab extension adding rainbow brackets/parentheses to the editor.

Project description

jupyterlab-rainbow-brackets

Github Actions Status Binder

A JupyterLab/Jupyter Notebook 7+ extension adding rainbow brackets/parentheses to the editor, based on rainbowbrackets.

Provides seven colours of brackets, with two sets of colors tuned for light and dark themes:

In Light Mode In Dark Mode
rainbow brackets in light mode rainbow brackets in dark mode

The colors are fully customizable in the settings:

rainbow brackets settings

Requirements

  • JupyterLab >= 4.0.0 or Jupyter Notebook >= 7.0.0

Install

To install the extension, execute:

pip install jupyterlab-rainbow-brackets

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-rainbow-brackets

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_rainbow_brackets 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-rainbow-brackets

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-rainbow-brackets 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_rainbow_brackets-0.1.0.tar.gz (235.6 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for jupyterlab_rainbow_brackets-0.1.0.tar.gz
Algorithm Hash digest
SHA256 598fcaba5b70a17aa5206ae4e5ae6b2d8aeb5af69e96e74656ef6a2c28e1cb73
MD5 f81b398a4e7e6215bb852a0de4a1685b
BLAKE2b-256 e259004e8a9b156e8688f8c7b91a13f813c4dd77a6b4d170be7f5dc5db604550

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for jupyterlab_rainbow_brackets-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ad980a4dd65e53dbd4160a9c8dbd9a3f7e1c5da1588f3d25d3a5d2b70eb1f8c8
MD5 30a7e649758ad47f330b04d811353622
BLAKE2b-256 c2c234e17d59d276a9f70610248f6b28f12a26dc0d65db1d351d3842f07e4fef

See more details on using hashes here.

Provenance

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