Skip to main content

A jupyter lab/notebook front-end extension for hiding cells after execution by specifying metadata "ihide": true

Project description

ihide

Github Actions StatusBinder A jupyter lab/notebook front-end extension for hiding cells after execution by specifying metadata "ihide": true

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install ihide

Uninstall

To remove the extension, execute:

pip uninstall ihide

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

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

ihide-0.1.0.tar.gz (89.0 kB view details)

Uploaded Source

Built Distribution

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

ihide-0.1.0-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file ihide-0.1.0.tar.gz.

File metadata

  • Download URL: ihide-0.1.0.tar.gz
  • Upload date:
  • Size: 89.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for ihide-0.1.0.tar.gz
Algorithm Hash digest
SHA256 38184971993703227a0e4c1297c66d4da628ac1dd15c18691c83cb8e28ae1ab6
MD5 0648b9b9e800d77b13f7e491a09ab791
BLAKE2b-256 f88855392bf195d69c210478fd1a0928bf32559ab751582001c9e475d227d00e

See more details on using hashes here.

File details

Details for the file ihide-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ihide-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for ihide-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1a12b18578e3e3d11b47686823773e56c9814bcb7dad64a4b0a7db8a0e1f980f
MD5 5f0d3936e83029505d4fb73d9e9ae414
BLAKE2b-256 48cf6e9e45023f6a67066af3ed5c5ba2f1a318529a33910302334b8d0b5c3998

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