Skip to main content

Widget Generator for JSON schema

Project description

ipywidgets-jsonschema - A widget generator for your Jupyter notebooks

License: MIT GitHub Workflow Status PyPI version Binder

This project allows you to generate Jupyter widgets from schemas that follow the JSONSchema specification. If you already have a schema available, creating a widget form for it is as simple as this:

from ipywidgets_jsonschema import Form
form = Form(schema)
form.show()

The data can then be retrieved from form by accessing form.data.

Features

These are the core features:

  • Generation of ipywidgets widgets for all basic types
  • Read and write access to the current document state

Installation

ipywidgets-jsonschema can be installed with pip:

python -m pip install ipywidgets-jsonschema

Known limitations

  • Some aspects of the JSON Schema specification are hard to implement in a form generator and are therefore omitted e.g.
    • The allOf and not rules for schema composition
    • Media types
    • Conditional subschemas (might be added)
  • Some annotations that are purely optional in the specification are required for the schema to be usable with ipywidgets-jsonschema e.g. a title field when the resulting widget would otherwise not be self-explanatory.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipywidgets_jsonschema-0.7.0.tar.gz (9.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page