Skip to main content

Small extension to add menu item under 'Tabs' to allow close all open tabs

Project description

jupyterlab_close_all_tabs_extension

GitHub Actions npm version PyPI version

Small extension to add menu item under 'Tabs' to allow close all open tabs

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_close_all_tabs_extension

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_close_all_tabs_extension

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

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_close_all_tabs_extension 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_close_all_tabs_extension-1.0.1.tar.gz (241.7 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file jupyterlab_close_all_tabs_extension-1.0.1.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_close_all_tabs_extension-1.0.1.tar.gz
Algorithm Hash digest
SHA256 74b478c0e7b6511f1cd9084a9b02cec23603895e54e780bf1786281d0c94182f
MD5 00930dacc81eafd2329bcbe7f7c2e497
BLAKE2b-256 3ec66c04b3ee0d9e0055342e2e75c2d1b4091ef8f89134eedb98e45ccc8b48b2

See more details on using hashes here.

File details

Details for the file jupyterlab_close_all_tabs_extension-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_close_all_tabs_extension-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 453e3ffb289af4e804f3ba71c69d6454c1cc72e85bff8466696784a0601f2ab9
MD5 5ce7200a703382afde3a019c24cba9d3
BLAKE2b-256 14279a1e35fcaf414954665e07c9230a0a65e3a62701c1de92dd6c0ba0b32aa2

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