Starter Metadata Schema¶
https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/starter-python/allOf/0
common metadata for Starters
Abstract |
Extensible |
Status |
Identifiable |
Custom Properties |
Additional Properties |
Access Restrictions |
Defined In |
|---|---|---|---|---|---|---|---|
Can be instantiated |
No |
Unknown status |
No |
Forbidden |
Allowed |
none |
v2.json* |
0 Type¶
object (Starter Metadata)
0 Properties¶
Property |
Type |
Required |
Nullable |
Defined by |
|---|---|---|---|---|
|
Required |
cannot be null |
||
|
Required |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
label¶
human-readable, plain-text description used in UI labels and tab titles
label
is required
Type:
string(Label)cannot be null
defined in: Jupyter Starters JSON
label Type¶
string (Label)
description¶
short, plain-text description of the intent of the Starter
description
is required
Type:
string(Description)cannot be null
defined in: Jupyter Starters JSON
description Type¶
string (Description)
icon¶
SVG string to use in Launcher cards and tab icons
icon
is optional
Type:
string(Icon)cannot be null
defined in: Jupyter Starters JSON
icon Type¶
string (Icon)
commands¶
JupyterLab commands to run after the Starter has completed
commands
is optional
Type:
object[](JupyterLab Command)cannot be null
defined in: Jupyter Starters JSON
commands Type¶
object[] (JupyterLab Command)
ignore¶
glob-style patterns for folders and files exclude from copying, with * for wildcards
ignore
is optional
Type:
string[]cannot be null
defined in: Jupyter Starters JSON
ignore Type¶
string[]
schema¶
Draft 7 JSON Schema that generates a form like this one, which must validate the user’s data. Description fields may include markdown
schema
is optional
Type:
object(JSON Schema)cannot be null
defined in: Jupyter Starters JSON
schema Type¶
object (JSON Schema)
uiSchema¶
react-jsonschema-form uiSchema
for customizing the selection of widgets
uiSchema
is optional
Type:
object(UI Schema)cannot be null
defined in: Jupyter Starters JSON
uiSchema Type¶
object (UI Schema)