Widget Generator for JSON schema
Project description
ipywidgets-jsonschema - A widget generator for your Jupyter notebooks
Usage
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
ipywidgetswidgets 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
Alternatively, you can get it from conda-forge:
conda install -c conda-forge 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
allOfandnotrules for schema composition are only partially or not at all supported. - Media types
- There is only rudimentary support for conditional subschemas (like
if-then-else)
- The
- Some annotations that are purely optional in the specification are required
for the schema to be usable with
ipywidgets-jsonschemae.g. atitlefield when the resulting widget would otherwise not be self-explanatory.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file ipywidgets_jsonschema-1.0.0.tar.gz.
File metadata
- Download URL: ipywidgets_jsonschema-1.0.0.tar.gz
- Upload date:
- Size: 2.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f7454a63b90bd25dbf1db364d9f8873bd810693528581dda2850f4d108e378a7 |
|
| MD5 | 057a14487d028cdb78db00f89720f5a6 |
|
| BLAKE2b-256 | 0546b975180baff1e20a990a1e4cfc3e15d237a82824c0e9292dbb91f64dbaad |
