Skip to main content

jl-hide-cells

Project description

jupyterlab-hide-cells

A JupyterLab extension.

Add metadata jupyterlab-hide-cells:hidden to cells to either hide or show these.

Toggle this option via right click on cell and click on "Show this cell" / "Hide this cell".

Two view mode: Standard Mode hide all cells with corresponding metadata. To also show hidden cells go to View => View All Cells (incl. Hidden Cells). Within this mode, the background of the cell is light purple to show that they are normally hidden.

preview

Requirements

  • JupyterLab >= 3.0
  • Tested on JupyterLab 3.2.0
  • Node (for installation via repository clone)

Install

(Un-)Installation via pip directly

To install the extension, execute:

pip install jupyterlab-hide-cells

To remove the extension, execute:

pip uninstall jupyterlab-hide-cells

Contributing

(Un-)Installation via Repository Clone

Installation via pip

pip install "."

Development Installation

# Clone the repo to your local environment
# Change directory to the jupyterlab-hide-cells 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 Uninstallation

pip uninstall jupyterlab-hide-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 jupyterlab-hide-cells within that folder.

Installation via jlpm

root@device:~/jupyterlab-hide-cells$ jlpm
# expected output:
yarn install v1.21.1
[1/4] Resolving packages...
success Already up-to-date.
Done in 0.76s.
root@device:~/jupyterlab-hide-cells$ jlpm build:lib:prod
# expected output
yarn run v1.21.1
$ tsc
Done in 11.77s.
root@device:~/jupyterlab-hide-cells$ jupyter labextension install .
# expected output:
Building jupyterlab assets (build:dev:minimize)

T.B.D.

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_hide_cells-1.0.1.tar.gz (1.2 MB view hashes)

Uploaded Source

Built Distribution

jupyterlab_hide_cells-1.0.1-py3-none-any.whl (15.0 kB view hashes)

Uploaded Python 3

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