JSON schemas for Jupyter.
This repo is currently a work in progress.
Thestable branch is configured to deploy via GitHub Pages to schema.jupyter.org. Content in thestable branch is considered published, canonical, and stable, whereas content inmain branch is considered in-progress, latest, pre-published.
https://schema.jupyter.org/[subproject]/[schema-path]/[version].json
[component] can be, e.g.jupyter-lab,jupyter-server,jupyter-hub,jupyter-kernel,jupyter-notebook, etc.[version] defines the version of the library for which you get the schema. Underspecified versions match the latest version of the unspecified part. For examplev1 matches the latest major release,v1.1 matches the latest minor release, andv1.1.1 matches an exact version.
The package included in this repo installs all of Jupyter's core schemas inJupyter's data directory, e.g. undershare/jupyter/schemas/.
Install this package using:
pip install jupyter-schemas
This package also includes small Python package for fetching these schemas
For example, to get a list of all installed schemas, try:
importjupyter_schemasprint(jupyter_schemas.list_schemas())
You can fetch the contents of a schemas from disk using:
# Use the schema's URI to find ituri="https://schema.jupyter.org/jupyter_server/events/contents_service/v1"# Load the schemaprint(jupyter_schemas.get_jupyter_schema(uri))