Skip to main content

Parametrized starter files and folders for Jupyter

Project description


Parameterized file and directory starters for JupyterLab.

releases deps ci demo docs
ci-badge binder-badge docs-badge


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


You'll need jupyterlab >=3,<4, python >=3.7, and nodejs >=12

pip install --pre jupyter_starters

Check your installation:

jupyter serverextension list
jupyter labextension list

If you don't see jupyterlab_starters run:

jupyter serverextension enable --sys-prefix jupyterlab_starters


Like the Jupyter Notebook 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 your notebook server 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.

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

more docs TBD: for now, see examples in the demo configuration.


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

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

jupyter_starters-1.1.0.tar.gz (204.6 kB view hashes)

Uploaded source

Built Distribution

jupyter_starters-1.1.0-py3-none-any.whl (408.2 kB view hashes)

Uploaded py3

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