Skip to main content

A redesigned JupyterLab launcher

Project description

jupyterlab-new-launcher

Github Actions Status Binder

A redesigned JupyterLab launcher

new launcher

Kernel selection dialog:

new dialog

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab-new-launcher

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-new-launcher

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

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-new-launcher 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_new_launcher-0.5.1.tar.gz (481.5 kB view details)

Uploaded Source

Built Distribution

jupyterlab_new_launcher-0.5.1-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_new_launcher-0.5.1.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_new_launcher-0.5.1.tar.gz
Algorithm Hash digest
SHA256 f3abe72a9b4459622442e58f8c112492de88a71f868a4b5e19a17c8b4112d36e
MD5 ac50099abbb52aa131dc7c618587231e
BLAKE2b-256 1520e31e465ece49bad06fe63a493e07be6ce35aa8ca418ed46826dbef97a985

See more details on using hashes here.

File details

Details for the file jupyterlab_new_launcher-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_new_launcher-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1f08be174ff2fb36c8bd38d2e2d7d4268e7fa453356ed8a1a53be8267ea69007
MD5 dc337480c84f954aff3f95b2a799e59d
BLAKE2b-256 befe9eff17e5ea0950d27ca0e5a7a179ee3cb412d64e881aed777d9eb1fd6e01

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