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¶
You’ll need
jupyterlab >=3,<4
,python >=3.7
, andnodejs >=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
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 the demo configuration.
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
- Python API
- REST API
- Jupyter Starters JSON Schema
- Jupyter Starters JSON Definitions
- Definitions group all-starters
- Definitions group starters
- Definitions group start-response
- Definitions group starter
- Definitions group starter-meta
- Definitions group command
- Definitions group starter-copy
- Definitions group starter-copy-with-dest
- Definitions group starter-notebook
- Definitions group starter-python
- Definitions group starter-with-src
- All JSON Schema
- API Version Schema
- Untitled string in Jupyter Starters JSON Schema
- Running Starters Schema
- All Starters Server Response Schema
- all-starters Properties
- Copy Type Schema
- Copy Starter Schema
- 0 Properties
- Copy Destination Schema
- Copy with Destination Starter Schema
- starter-copy-with-dest Properties
- Arguments Schema
- Command ID Schema
- JupyterLab Command Schema
- items 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
- Commands Schema
- Description Schema
- Icon Schema
- Untitled string in Jupyter Starters JSON Schema
- Ignore Files Schema
- JSON Schema Schema
- Label Schema
- UI Schema Schema
- Starter Metadata Schema
- 0 Properties
- Starter Type Schema
- Starter Python Source Schema
- Starter Source Schema
- Starter with Files Schema
- starter-with-src Properties
- Starter Schema
- starter 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 starters
- Definitions group start-response
- Definitions group starter
- Definitions group starter-meta
- Definitions group command
- Definitions group starter-copy
- Definitions group starter-copy-with-dest
- Definitions group starter-notebook
- Definitions group starter-python
- Definitions group starter-with-src
- For Posterity
- CHANGELOG
jupyter_starters 1.1.0
@deathbeds/jupyterlab-starters 1.1.0
@deathbeds/jupyterlab-rjsf 1.1.0
jupyter_starters 1.0.2
@deathbeds/jupyterlab-starters 1.0.2
@deathbeds/jupyterlab-rjsf 1.0.2
jupyter_starters 1.0.1a0
@deathbeds/jupyterlab-starters 1.0.1a0
@deathbeds/jupyterlab-rjsf 1.0.1a0
jupyter_starters 1.0.0a0
@deathbeds/jupyterlab-rjsf 1.0.0a0
@deathbeds/jupyterlab-starters 1.0.0a0
jupyter_starters 0.6.0a0
@deathbeds/jupyterlab-rjsf 0.6.0a0
@deathbeds/jupyterlab-starters 0.6.0a0
jupyter_starters 0.5.0a0
@deathbeds/jupyterlab-rjsf 0.5.0a0
@deathbeds/jupyterlab-starters 0.5.0a0
@deathbeds/jupyterlab-rjsf 0.4.0a0
@deathbeds/jupyterlab-starters 0.4.0a0
jupyter_starters 0.4.0a0
jupyter_starters 0.3.0a0
@deathbeds/jupyterlab-starters 0.3.0a0
jupyter_starters 0.2.2a0
@deathbeds/jupyterlab-starters 0.2.2a0
jupyter_starters 0.2.1a0
@deathbeds/jupyterlab-starters 0.2.1a0
jupyter_starters 0.2.0a0
@deathbeds/jupyterlab-starters 0.2.0a0
jupyter_starters 0.1.0a3
jupyter_starters 0.1.0a2
@deathbeds/jupyterlab-starters 0.1.0a2
jupyter_starters 0.1.0a1
@deathbeds/jupyterlab-starters 0.1.0a0
jupyter_starters 0.1.0a0
- ROADMAP
- License