jupyterlab-starters#

Parameterized file and directory starters for JupyterLab.

releases	deps	ci	demo	docs

screenshot

What’s a starter?#

A starter is a…

single file
directory
python function
cookiecutter
notebook

… that creates a…

single file
directory of files (or more directories)

… that shows up where you want it in JupyterLab at the click of a button

Installing#

pip install jupyter-starters jupyterlab=3
# or
mamba install -c conda-forge jupyter-starters jupyterlab=3
# or
conda install -c conda-forge jupyter-starters jupyterlab=3

Configuring#

Like the Jupyter Server, JupyterHub and other Jupyter interactive computing tools, jupyter-starters can be configured via Python or JSON files in well-known locations. You can find out where to put them on your system with:

jupyter --paths

They will be merged from bottom to top, and the directory where you launch jupyter lab wins, making it easy to check in to version control.

The very simplest starter, copy, will copy a file or folder to the location it is launched from in the JupyterLab Launcher.

Hint

an example jupyter_server_config.json

{
  "StarterManager": {
    "extra_starters": {
      "whitepaper-single": {
        "type": "copy",
        "label": "Whitepaper Notebook",
        "description": "A reusable notebook for proposing research",
        "src": "examples/whitepaper-single.ipynb"
      }
    }
  }
}

Alternatives#

Don’t like what you see here? Try these other approaches:

jupyterlab_templates