jupyterlab-starters#
Parameterized file and directory starters for JupyterLab.
releases |
deps |
ci |
demo |
docs |
---|---|---|---|---|
What’s a starter?#
A starter is a…
single file
directory
python function
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:
Documentation Contents#
- For Starters
- For Users
- CLI
- For Developers
- Use Cases
- Packaging Starters
- JupyterLite
- Including Starters in a JupyterLite site
- Python API
- Starter Manager
DEFAULT_ENV_CLS
StarterManager
StarterManager.contents_manager
StarterManager.just_copy()
StarterManager.kernel_manager
StarterManager.resolve_src()
StarterManager.running
StarterManager.save_content()
StarterManager.save_contents_model()
StarterManager.save_one_file()
StarterManager.start()
StarterManager.start_content()
StarterManager.start_copy()
StarterManager.start_notebook()
StarterManager.start_python()
StarterManager.starter_names
StarterManager.starters
StarterManager.stop()
StarterManager.stop_notebook()
iter_not_ignored()
- Starters
- Miscellaneous
- Starter Manager
- REST API
- Jupyter Starters JSON Schema
- Jupyter Starters JSON Definitions
- Definitions group all-starters
- Definitions group command
- Definitions group start-response
- Definitions group starter
- Definitions group starter-content
- Definitions group starter-content-any
- Definitions group starter-content-directory
- Definitions group starter-content-file-common
- Definitions group starter-content-file-json
- Definitions group starter-content-file-text
- Definitions group starter-copy
- Definitions group starter-copy-with-dest
- Definitions group starter-meta
- Definitions group starter-notebook
- Definitions group starter-python
- Definitions group starter-with-content
- Definitions group starter-with-src
- Definitions group starters
- All JSON Schema
- An Array Schema
- An Object Schema
- Untitled undefined type in Jupyter Starters JSON Schema
- Untitled string in Jupyter Starters JSON Schema
- Untitled undefined type in Jupyter Starters JSON Schema
- A JSON File Schema
- starter-content-file-json Properties
- Untitled undefined type in Jupyter Starters JSON Schema
- A root of Jupyter contents Schema
- starter-with-content Properties
- Untitled string in Jupyter Starters JSON Schema
- Untitled string in Jupyter Starters JSON Schema
- Untitled undefined type in Jupyter Starters JSON Schema
- A Text File Schema
- starter-content-file-text Properties
- API Version Schema
- Untitled string in Jupyter Starters JSON Schema
- Running Starters Schema
- All Starters Server Response Schema
- all-starters Properties
- A root of Jupyter contents Schema
- 1 Properties
- Contents Starter Schema
- Copy Type Schema
- Copy Starter Schema
- starter-copy Properties
- Copy Destination Schema
- Copy with Destination Starter Schema
- starter-copy-with-dest Properties
- Untitled array in Jupyter Starters JSON Schema
- Untitled string in Jupyter Starters JSON Schema
- Jupyter Contents Directory Schema
- starter-content-directory Properties
- Untitled string in Jupyter Starters JSON Schema
- Untitled string in Jupyter Starters JSON Schema
- Jupyter Contents File Schema
- starter-content-file-common Properties
- Arguments Schema
- Command ID Schema
- JupyterLab Command Schema
- command Properties
- Notebook Type Schema
- Notebook Starter Schema
- starter-notebook Properties
- Python Callable Schema
- Python Type Schema
- Python Starter Schema
- starter-python Properties
- API Path Schema
- Body Schema
- Error Text Schema
- Errors Schema
- Force Copy Schema
- Name Schema
- Status Schema
- Start Response Schema
- start-response Properties
- Untitled string in Jupyter Starters JSON Schema
- Untitled object in Jupyter Starters JSON Schema
- 0 Properties
- Untitled undefined type in Jupyter Starters JSON Schema
- Content File Schema
- Content Folder Schema
- Untitled undefined type in Jupyter Starters JSON Schema
- Untitled object in Jupyter Starters JSON Schema
- Category Schema
- Commands Schema
- Description Schema
- Icon Schema
- Untitled string in Jupyter Starters JSON Schema
- Ignore Files Schema
- JSON Schema Schema
- Label Schema
- Rank Schema
- UI Schema Schema
- Starter Metadata Schema
- starter-meta Properties
- Starter Type Schema
- Starter Python Source Schema
- Starter Source Schema
- Starter with Files Schema
- starter-with-src Properties
- Starter Schema
- additionalProperties Properties
- Starters Schema
- starters Properties
- Untitled undefined type in Jupyter Starters JSON Schema
- Jupyter Starters JSON Schema
- Jupyter Starters JSON Definitions
- Definitions group all-starters
- Definitions group command
- Definitions group start-response
- Definitions group starter
- Definitions group starter-content
- Definitions group starter-content-any
- Definitions group starter-content-directory
- Definitions group starter-content-file-common
- Definitions group starter-content-file-json
- Definitions group starter-content-file-text
- Definitions group starter-copy
- Definitions group starter-copy-with-dest
- Definitions group starter-meta
- Definitions group starter-notebook
- Definitions group starter-python
- Definitions group starter-with-content
- Definitions group starter-with-src
- Definitions group starters
- For Posterity
- CHANGELOG
- ROADMAP
- License