Skip to main content

Run all cells marked as 'init' with 1 click

Project description

jupyter-run-init-cells

Github Actions Status

Run all cells marked as 'init' with 1 click

How to use

  1. Mark the cells you want to run on notebook load with the tag init. You can add tags to a cell by clicking on the cell, then clicking on the "Tags" button in the toolbar (or using the keyboard shortcut Ctrl+Shift+T), and typing init in the input field.

Add tag to cell

  1. Click on the "Run Init Cells" button in the toolbar (or use the keyboard shortcut Ctrl+I) to run all cells marked with the init tag.

Run init cells

  1. Any cells not marked with the init tag will not be run.

Requirements

  • JupyterLab >= 4.5.0

Install

To install the extension, execute:

pip install jupyter-run-init-cells

Uninstall

To remove the extension, execute:

pip uninstall jupyter-run-init-cells

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 jupyter-run-init-cells directory

# Set up a virtual environment and install package in development mode
python -m venv .venv
source .venv/bin/activate
pip install --editable "."

# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite

# Rebuild extension Typescript source after making changes
# IMPORTANT: Unlike the steps above which are performed only once, do this step
# every time you make a change.
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 jupyter-run-init-cells

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 jupyter-run-init-cells 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

jupyter_run_init_cells-0.1.3.tar.gz (532.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyter_run_init_cells-0.1.3-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_run_init_cells-0.1.3.tar.gz.

File metadata

  • Download URL: jupyter_run_init_cells-0.1.3.tar.gz
  • Upload date:
  • Size: 532.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for jupyter_run_init_cells-0.1.3.tar.gz
Algorithm Hash digest
SHA256 3eeb1eef1082c3dd3cf82c70bd8a48dd9a475633d398dd0cd9d045e7f30eb4a5
MD5 58dccf992835d5613eeabbc8f8f1ad28
BLAKE2b-256 b51b407a0bf7886f76c801a8d449f29b9acf8bb3da1470e8c188a4d0f4097b70

See more details on using hashes here.

File details

Details for the file jupyter_run_init_cells-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_run_init_cells-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 922aa40d5ad0f2efbfb5c003cbdfed01db32689533f7ae9090bb7f07205a3fdd
MD5 3ed1a542d2bf628c6f6cb62f5c6ad603
BLAKE2b-256 a9ccf7f0b38ce8da1ab120057d79c8152fd46256bcdb3a3233c8a3ae6f08af95

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page