Skip to main content

JupyterLab extension to show a flash effect when a cell is executed

Project description

jupyterlab-cell-flash

Github Actions Status Binder PyPI npm

JupyterLab extension to show a flash effect when a cell is executed.

Requirements

  • JupyterLab >= 2.0

Install

For JupyterLab 3.x, the extension can be installed with pip:

pip install jupyterlab-cell-flash

For JupyterLab 1.x and 2.x:

jupyter labextension install jupyterlab-cell-flash

Settings

Use the following settings to tweak the color and the duration of the animation (in Settings > Advanced Settings Editor):

{
  // The base color for the flash effect
  "color": "rgba(255, 255, 0, 0.5)",

  // The duration of the flash effect animation (in seconds)
  "duration": 0.5
}

settings

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-cell-flash directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jlpm run install:extension
# Rebuild extension Typescript source after making changes
jlpm run 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 run 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).

Uninstall

pip uninstall jupyterlab-cell-flash
jupyter labextension uninstall jupyterlab-cell-flash

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-cell-flash-0.3.3.tar.gz (121.2 kB view details)

Uploaded Source

Built Distribution

jupyterlab_cell_flash-0.3.3-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab-cell-flash-0.3.3.tar.gz.

File metadata

  • Download URL: jupyterlab-cell-flash-0.3.3.tar.gz
  • Upload date:
  • Size: 121.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for jupyterlab-cell-flash-0.3.3.tar.gz
Algorithm Hash digest
SHA256 e9def20b9ebdecf8830d91451c8e4d5b90918a08f680a16154ac69059c28c217
MD5 e6673f0982c80512b3c16f2ba4332220
BLAKE2b-256 683dcc5185fc9d39094d5e7636fdcc1fdc562015d555261d1d8231cdfd2eef66

See more details on using hashes here.

File details

Details for the file jupyterlab_cell_flash-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_cell_flash-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for jupyterlab_cell_flash-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 03033c1177a8ce3f2ff20256d708f54af0e9c43fd39446d109facb48ea78268e
MD5 6050dae63b587cba18e1dbed8f5304d7
BLAKE2b-256 ddc5f4f6f709f46434c3ca66dd3a731c884c842b57b0f84128cc2dd35c4dc9db

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