Skip to main content

A JupyterLab theme extension for Composable DataLabs.

Project description

jupyterlab_ca_theme

Github Actions Status A JupyterLab theme extension for Composable DataLabs.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyterlab_ca_theme

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_ca_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_ca_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_ca_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-ca-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

jupyterlab_ca_theme-0.2.2.tar.gz (218.4 kB view details)

Uploaded Source

Built Distribution

jupyterlab_ca_theme-0.2.2-py3-none-any.whl (75.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_ca_theme-0.2.2.tar.gz.

File metadata

  • Download URL: jupyterlab_ca_theme-0.2.2.tar.gz
  • Upload date:
  • Size: 218.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for jupyterlab_ca_theme-0.2.2.tar.gz
Algorithm Hash digest
SHA256 a9f035f1597ccbd19e12af4f9ad7d78a8bc06982ef565863301269c67fb3e180
MD5 14f917ced8b10ae08a983e1fcad7054f
BLAKE2b-256 0a71bc82c0db1ad4b85bd4db485623289d77bbd4bf3f94a4f055e3f98517a58f

See more details on using hashes here.

File details

Details for the file jupyterlab_ca_theme-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_ca_theme-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a30da72c96a16e791a3746fa846a8ce6a359baa92e50fe5e0f57738b401f2a78
MD5 175c6b9d7e535d2d9b4e7fb5ec3a19b7
BLAKE2b-256 f9153bd9c6c4cd155afa46f5b17e5f4d9461cdb40e81300dcb7376e42ad95997

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