Skip to main content

A dark, easy-on-the-eyes theme for JupyterLab.

Project description

jupyterlab_henanigans

Github Actions Status A JupyterLab extension.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_henanigans

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_henanigans

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

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_henanigans` 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_henanigans-0.3.1.tar.gz (97.0 kB view details)

Uploaded Source

Built Distribution

jupyterlab_henanigans-0.3.1-py3-none-any.whl (43.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_henanigans-0.3.1.tar.gz.

File metadata

  • Download URL: jupyterlab_henanigans-0.3.1.tar.gz
  • Upload date:
  • Size: 97.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.12.4 CPython/3.10.12

File hashes

Hashes for jupyterlab_henanigans-0.3.1.tar.gz
Algorithm Hash digest
SHA256 d6337caf7d4d7c7da774ce0ba920f54042abf789f5ccd41c45a7b88330a5f207
MD5 cf09f655ae854eea4a6e7ce503066929
BLAKE2b-256 7f89290ca4a15ac15c16e770d782281a0b6f4029eac042b79bb3a358c03a2b06

See more details on using hashes here.

File details

Details for the file jupyterlab_henanigans-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_henanigans-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 69eb7d87e785d453c9e12e61de8e168a3d3bc805fa363406de3d8724f050b473
MD5 254182994f36c4c6cc14181b66c4a41e
BLAKE2b-256 b9c4672f81be443d7bfa2256326126dfcec40e8de37a687ddb448c6a8ab36a2d

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