Skip to content

eddienko/jupyterlab-apps-launcher

Repository files navigation

jupyterlab-apps-launcher

Github Actions Status

A JupyterLab extension that replaces the default launcher with one where you can configure which categories appear. For example you can remove the "Console" or the "Other" category or you can add a new category. Note that for the latter to appear it needs another extension that actually puts launchers in that category.

Categories and their icons are defined in the settings under "App Launcher".

Screenshots

New "Application" section addded.

Removed console category from launcher.

Requirements

  • JupyterLab >= 3.0

Install

pip install jupyterlab-apps-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-apps-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 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

Uninstall

pip uninstall jupyterlab-apps-launcher