Skip to main content

A JupyterLab extension that adds footer buttons to code cells for improved interactivity and visibility control, supporting operations like running cells, hiding/showing code, and managing output directly from the cell interface. Initial functionality included to mark documentation cells that are controlled by their corresponding code cells.

Project description

jupyter_bridge

Github Actions Status Binder A JupyterLab extension that adds footer buttons to code cells for improved interactivity and visibility control, supporting operations like running cells, hiding/showing code, and managing output directly from the cell interface. Initial functionality included to mark documentation cells that are controlled by their corresponding code cells.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyter_bridge

Uninstall

To remove the extension, execute:

pip uninstall jupyter_bridge

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_bridge 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 jupyter_bridge

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

jupyter_bridge-0.4.0.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

jupyter_bridge-0.4.0-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

Details for the file jupyter_bridge-0.4.0.tar.gz.

File metadata

  • Download URL: jupyter_bridge-0.4.0.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for jupyter_bridge-0.4.0.tar.gz
Algorithm Hash digest
SHA256 f51c064dc6a2c444583cf15b3d297840608825ea534f03d2791d922f2b8ce471
MD5 8135461a9dd8fd99f5fbb8cd49bce56e
BLAKE2b-256 a4f644c6bc2c7189c9b643105638fe22d25b8a568981dd508b334e67d6f425d2

See more details on using hashes here.

File details

Details for the file jupyter_bridge-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_bridge-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 13c7598e4e1550f8609123ce0d199ef4be31a06502e59982d14f354c6ef763d8
MD5 54f1ca30dd8065f13ed997cf9b4e514d
BLAKE2b-256 655e47eff06322858a6077ea0428d1a80ec406a7ab99a7716001ccaa1a3aed13

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