Skip to main content

Prompt when JupyterLab window is closed

Project description

jupyterlab-promptclose

Build

Prompt when JupyterLab window is closed.

Do you find yourself using the Ctrl-w keyboard shortcut (delete the previous word in Bash) in a JupyterLab terminal and accidentally closing your browser window instead? Then install this extension and you should see a prompt before the window is closed.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyterlab-promptclose

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-promptclose

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-promptclose 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 run 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 run 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 run 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-promptclose

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-promptclose within that folder.

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-promptclose-0.1.0.tar.gz (79.7 kB view details)

Uploaded Source

Built Distribution

jupyterlab_promptclose-0.1.0-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab-promptclose-0.1.0.tar.gz.

File metadata

  • Download URL: jupyterlab-promptclose-0.1.0.tar.gz
  • Upload date:
  • Size: 79.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.10

File hashes

Hashes for jupyterlab-promptclose-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d5c8589c5a517eef71395974beb738ea1bca382dfe29aefe085a77ceede084c7
MD5 a87a46c8a57496b5018d9fd13067300c
BLAKE2b-256 5e831ad52dcaa02838bc7007f9c59215e4924e0f494a0fd2fee746a0ae8cdab7

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: jupyterlab_promptclose-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.10

File hashes

Hashes for jupyterlab_promptclose-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 47f2bbec9e303ccafcdc69f889b6eacfb1c5d9b84d0fccb22abab48b7655fd9a
MD5 79741dd88310d96e839171d19039aacb
BLAKE2b-256 ebb0c2394b4fd5a719173cd88a3e7eaaf0086b36ed6b4cf036e2c7187de9dc49

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