Skip to main content

A JupyterLab color picker

Project description

jupyterlab-color-picker

Github Actions Status Binder

A JupyterLab extension adding color picker in Python, Julia, R, CSS, JavaScript and TypeScript.

color picker

Based on @replit/codemirror-css-color-picker.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab-color-picker

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-color-picker

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

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-color-picker 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_color_picker-0.1.0.tar.gz (304.0 kB view details)

Uploaded Source

Built Distribution

jupyterlab_color_picker-0.1.0-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jupyterlab_color_picker-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1a3db9be4dd7fa52e394d0fee9c4bb952a17daec3c488b46d7d53ae6df4017cc
MD5 20f4839dac860f986d3e132e3ffc2234
BLAKE2b-256 dadd7900f7a9e7582fd1c1e6cf59bac9ff0055b5e55eb87773853e932d0a6642

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for jupyterlab_color_picker-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a064ad8fca41b24b8802598eb6a3a0d3dc3191a5db086ed788777b641ac2454e
MD5 5c1a2968ad57dd682f8a28270f2d8f69
BLAKE2b-256 0f0a1cb16a3bbb8e3f339787f0b520e1aa928dae6e73bd9ca15987c421ae58be

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