Skip to main content

A enhanced launcher for JupyterLab

Project description

jlab-enhanced-launcher

Extension status Github Actions Status Binder npm PyPI conda-forge

A enhanced launcher for JupyterLab.

Demo

This codes started from https://github.com/jupyterlab/jupyterlab/pull/5953.

Requirements

  • JupyterLab >= 4.0.0

For JupyterLab 3.x, have look there. For JupyterLab 2.x, have look there.

Install

To install the extension, execute:

pip install jlab-enhanced-launcher

or

conda install -c conda-forge jlab-enhanced-launcher

Uninstall

To remove the extension, execute:

pip uninstall jlab-enhanced-launcher

or

conda remove -c conda-forge jlab-enhanced-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 jlab_enhanced_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 jlab-enhanced-launcher

or

conda remove -c conda-forge jlab-enhanced-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 @jlab-enhanced/launcher within that folder.

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

jlab_enhanced_launcher-4.0.1.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

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

jlab_enhanced_launcher-4.0.1-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file jlab_enhanced_launcher-4.0.1.tar.gz.

File metadata

  • Download URL: jlab_enhanced_launcher-4.0.1.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jlab_enhanced_launcher-4.0.1.tar.gz
Algorithm Hash digest
SHA256 9b3c3b8caa44a2eb477f9b9ef2486a938ccd82c7ca1d87da4ddf6c501c85a73a
MD5 a27c1f1e0fd831f952886316f8e8a089
BLAKE2b-256 474a6a85ac0ad8e229ea97387313eba80082b14f7ac7c22895d8d9215a371b6c

See more details on using hashes here.

File details

Details for the file jlab_enhanced_launcher-4.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jlab_enhanced_launcher-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7b6f13526a7f3e7ca8f09e653715edc116512c9084079368806a1d9dc98dac32
MD5 7920eb860be5932131aa0beb09b0484b
BLAKE2b-256 87c86a88748ba9322c615183dac45ee80f1e88a95ecf5bc0491022d42cc144ce

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