Skip to content

trungleduc/jupyter_app_launcher

Repository files navigation

jupyter_app_launcher

Github Actions Status Documentation Status Binder JupyterLite

A JupyterLab extension to create custom launcher entries

jupyter_app_launcher helps users customize the JupyterLab launcher with a simple YAML file. Users can add custom entries to the launcher to:

  • Open a predefined notebook with selected widget factory
  • Open a markdown file.
  • Render a notebook in dashboard mode
  • Open a notebook with Voila
  • Start a local web server and open the predefined URL.
  • Open a remote URL (as widget tab in Jupyter or in new browser window).
  • Open terminal and run a predefined command
demo.mp4

Try it online!

You can try it online by clicking on this badge:

Binder

Or you can run it directly in your browser with JupyterLite:

JupyterLite

Documentation

You can read the documentation following this link: https://jupyter-app-launcher.readthedocs.io/

Installation

You can install using pip:

pip install jupyter-app-launcher

Or using conda:

conda install -c conda-forge  jupyter_app_launcher

jupyter_app_launcher works with JupyterLab>=3.1

Example

Open a predefined notebook

Dynamic layout

Open a predefined markdown file

Dynamic layout

Render a notebook in dashboard mode

Dynamic layout

Open a notebook with Voila

Dynamic layout

Start a local web server and open the URL.

Dynamic layout

Open a remote URL

Dynamic layout

Contributing

See Contributing

Packaging the extension

See RELEASE