For Users#

Installing#

Get up and running fast with pip:

pip install jupyter-starters jupyterlab=3

or

mamba install -c conda-forge jupyter-starters jupyterlab-3

or

mamba install -c conda-forge jupyter-starters jupyterlab-3

Using#

  • When JupyterLab opens, and configured starters will appear in the Launcher.

Extras#

Cookiecutter#

jupyter_starters integrates with (but doesn’t require) cookiecutter.

pip install cookiecutter

or conda

conda install -c conda-forge cookiecutter

CLI#

You can list your available starters with the jupyter starters list CLI.

!jupyter starters list --help
List all installed starters.

Options
=======
The options below are convenience aliases to configurable class-options,
as listed in the "Equivalent to" description-line of the aliases.
To see all configurable class-options for some <cmd>, use:
    <cmd> --help-all

--debug
    set log level to logging.DEBUG (maximize logging output)
    Equivalent to: [--Application.log_level=10]
--show-config
    Show the application's configuration (human-readable format)
    Equivalent to: [--Application.show_config=True]
--show-config-json
    Show the application's configuration (json format)
    Equivalent to: [--Application.show_config_json=True]
--generate-config
    generate default config file
    Equivalent to: [--JupyterApp.generate_config=True]
-y
    Answer yes to any questions instead of prompting.
    Equivalent to: [--JupyterApp.answer_yes=True]
--json
    List starters as JSON instead of YAML
    Equivalent to: [--StartersListApp.json=True]
--log-level=<Enum>
    Set the log level by value or name.
    Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
    Default: 30
    Equivalent to: [--Application.log_level]
--config=<Unicode>
    Full path of a config file.
    Default: ''
    Equivalent to: [--JupyterApp.config_file]

To see all available configurables, use `--help-all`.