Skip to main content

fixes regex pattern for reset-on-load command.

Project description

jupyterlab_reset_fixer

Github Actions Status IT fixes regex pattern for reset-on-load command. reset= also triggers workspace reset.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyterlab_reset_fixer

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_reset_fixer

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

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-reset-fixer 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_reset_fixer-0.0.2.tar.gz (312.7 kB view details)

Uploaded Source

Built Distribution

jupyterlab_reset_fixer-0.0.2-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_reset_fixer-0.0.2.tar.gz.

File metadata

  • Download URL: jupyterlab_reset_fixer-0.0.2.tar.gz
  • Upload date:
  • Size: 312.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for jupyterlab_reset_fixer-0.0.2.tar.gz
Algorithm Hash digest
SHA256 56c974130c4b235057a11509beea03337c362bdf56e395a7fd8098398e012314
MD5 415d51e4f7ef9d1021541ecc1e11907d
BLAKE2b-256 f819d3f809cbc258ee47d587946a084e58dfa41089d6e3827cc0faf4cc40214f

See more details on using hashes here.

File details

Details for the file jupyterlab_reset_fixer-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_reset_fixer-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 caf6bddfb00ab6b79b068767f5d5c2d0f49a640a9933b83ae467daaea23a875c
MD5 8be317b4d0bb324122af29edef118f89
BLAKE2b-256 d4c553cd13f0ac24a7925522e6212df181598378446926105376b1522a632b6f

See more details on using hashes here.

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