Starter Metadata Schema#

https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v3.json#/definitions/starter-meta

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	v3.json*

starter-meta Type#

object (Starter Metadata)

starter-meta Properties#

Property	Type	Required	Nullable	Defined by
category	`string`	Optional	cannot be null	Jupyter Starters JSON
commands	`array`	Optional	cannot be null	Jupyter Starters JSON
description	`string`	Required	cannot be null	Jupyter Starters JSON
icon	`string`	Optional	cannot be null	Jupyter Starters JSON
ignore	`array`	Optional	cannot be null	Jupyter Starters JSON
label	`string`	Required	cannot be null	Jupyter Starters JSON
rank	`integer`	Optional	cannot be null	Jupyter Starters JSON
schema	`object`	Optional	cannot be null	Jupyter Starters JSON
uiSchema	`object`	Optional	cannot be null	Jupyter Starters JSON

category#

category to place the starter card under in Launcher

category

is optional
Type: string (Category)
cannot be null
defined in: Jupyter Starters JSON

category Type#

string (Category)

category Default Value#

The default value is:

"Starters"

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)

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)

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[]

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)

rank#

rank of the launcher card within its category, lowest value will appear first

rank

is optional
Type: integer (Rank)
cannot be null
defined in: Jupyter Starters JSON

rank Type#

integer (Rank)

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)