Skip to main content

A JupyterLab extension.

Project description

jupyterlab-connectionloss_opt

Github Actions Status A JupyterLab extension.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab-connectionloss_opt

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-connectionloss_opt

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

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 connection-opt 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_connectionloss_opt-0.1.0.tar.gz (435.9 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for jupyterlab_connectionloss_opt-0.1.0.tar.gz
Algorithm Hash digest
SHA256 35ecfb10ef0d79fe4ae3bfdae7f01698c406bc78fa6d71aaa8463868d0b444a5
MD5 537e136115ab639ce3e5fbca98a57a7a
BLAKE2b-256 fc3871076d183a1ce98140f29076611561551fda6c4399791c51be2d187e2793

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyterlab_connectionloss_opt-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3f4b7fe51281ad45add1276feb1105a0e2f6e9c1dcc724e05fed9147982c19fa
MD5 c15decc67050f0394300e33e50d46f79
BLAKE2b-256 5cf1ed88a1c30a900ec2ce0d9bc0040efc6582697f6af67770a62a6445d2a880

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