A Python DSL for defining JSON schemas
Project description
Documentation | GitHub | PyPI
JSL is a Python DSL for defining JSON Schemas.
Example
import jsl
class Entry(jsl.Document):
name = jsl.StringField(required=True)
class File(Entry):
content = jsl.StringField(required=True)
class Directory(Entry):
content = jsl.ArrayField(jsl.OneOfField([
jsl.DocumentField(File, as_ref=True),
jsl.DocumentField(jsl.RECURSIVE_REFERENCE_CONSTANT)
]), required=True)
Directory.get_schema(ordered=True) will return the following JSON schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"directory": {
"type": "object",
"properties": {
"name": {"type": "string"},
"content": {
"type": "array",
"items": {
"oneOf": [
{"$ref": "#/definitions/file"},
{"$ref": "#/definitions/directory"}
]
}
}
},
"required": ["name", "content"],
"additionalProperties": false
},
"file": {
"type": "object",
"properties": {
"name": {"type": "string"},
"content": {"type": "string"}
},
"required": ["name", "content"],
"additionalProperties": false
}
},
"$ref": "#/definitions/directory"
}
Installing
pip install jsl
License
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
jsl-0.1.0.tar.gz
(19.4 kB
view details)
File details
Details for the file jsl-0.1.0.tar.gz.
File metadata
- Download URL: jsl-0.1.0.tar.gz
- Upload date:
- Size: 19.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1ec201bab56690c42100f063f66ee3995d768006ba65eb25d81d123e70e80562 |
|
| MD5 | 6d65ccf691f8751a4eccd68f2a1595c9 |
|
| BLAKE2b-256 | 1ea520cf8661bcdcae6ed89018dc883ca7f2a25482c971a0cc066fe2864866b2 |
