jupyterlab-starters

Parameterized file and directory starters for JupyterLab.

What's a starter?

• A single file
• A directory
• A python function
• A cookiecutter
• A shell script

... that shows up in your JupyterLab at the click of a button

Installing

You'll need jupyterlab >=1,<2, python >=3.6, and nodejs >=8

pip install --pre jupyter_starters
jupyter labextension install @deathbeds/jupyterlab-starters

Configuring

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 jupyter_notebook_config.json

Alternatives

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

• jupyterlab_templates