Skip to main content

Jupyter freeze extension for jupyterlab!

Project description

jupyterlab_freeze

Jupyter freeze extension for jupyterlab!

This extension is based on the freeze extension by jupyter_contrib_nbextensions.

This repository brings the extension to jupyterlab.

This extension allows to make cells read-only or frozen. It provides three buttons:

  • unlock
  • read-only
  • frozen

For code-cells:

  • read-only: it can be executed, but its input cannot be changed.
  • frozen: It cannot be either altered or executed.

For markdown-cells:

  • read-only / frozen: It's input can be viewed by double-clicking on it, but cannot be changed.

To change the state of a selected cell, press the corresponding button.

The individual cell's state is stored in its metadata and is applied to the cell if the extension is loaded.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_freeze

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_freeze

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

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

jupyterlab_freeze-0.1.1.tar.gz (794.5 kB view details)

Uploaded Source

Built Distribution

jupyterlab_freeze-0.1.1-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_freeze-0.1.1.tar.gz.

File metadata

  • Download URL: jupyterlab_freeze-0.1.1.tar.gz
  • Upload date:
  • Size: 794.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.11.2 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.1.0 tqdm/4.66.1 importlib-metadata/6.11.0 keyring/24.3.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.12

File hashes

Hashes for jupyterlab_freeze-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6ce80f9f469418e235af51795bf844d25a85490d8a0733dc160d5f6b32d03485
MD5 808dcbe9026ab5b03d3215ad5e21f587
BLAKE2b-256 4a4bc5a2681164550049bbc9f0dacccedb5a74bfebe292e99441733939b11486

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_freeze-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_freeze-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.11.2 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.1.0 tqdm/4.66.1 importlib-metadata/6.11.0 keyring/24.3.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.12

File hashes

Hashes for jupyterlab_freeze-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fa18d4c3dc180eb7094eda9bba01001eba69ee15ea4341c1e9186b9433a55051
MD5 2c9440cf35390b4b9ffab5d76238ecfd
BLAKE2b-256 34a3912c330002fc3db7c3f31d3fcc66a1cefbd4728895c73e3bd357348e1680

See more details on using hashes here.

Provenance

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