jsonschema2md
Convert JSON Schemas to simple, human-readable Markdown documentation.
For example:
{
"$id": "https://example.com/person.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Person",
"description": "JSON Schema for a person object.",
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "The person's first name."
},
"lastName": {
"type": "string",
"description": "The person's last name."
}
}
}
will be converted to:
Person
JSON Schema for a person object.
Properties
firstName(string): The person's first name.lastName(string): The person's last name.
See the examples directory for more elaborate examples.
Installation
Install with pip
$ pip install jsonschema2md
Usage
From the CLI
$ jsonschema2md <input.json> <output.md>
From Python
import jsonschema2md
parser = jsonschema2md.Parser()
md_lines = parser.parse_schema(json.load(input_json))
Contributing
Bugs, questions or suggestions? Feel free to post an issue in the issue tracker or to make a pull request! See Contributing.md for more info.
Changelog
See Changelog.md.
Release files for jsonschema2md 0.2.0.post1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jsonschema2md-0.2.0.post1.tar.gz | 8.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jsonschema2md-0.2.0.post1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.5 kB
Release files / jsonschema2md-0.2.0.post1.tar.gz
| Download URL | jsonschema2md-0.2.0.post1.tar.gz |
|---|---|
| Size | 8.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
86a25efcd7b25e2ba90e067648fbc3b2a9b7fece58b4fd7aa8d527a9d5b2c4af
|
|
BLAKE2b-256 checksum How to use checksums |
c9b23428ab07f308f09844277044d5ac2d96d8dfb895f9cb71352dcf6bd23737
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.6 CPython/3.9.4 Linux/5.4.0-1043-azure
|
Release files / jsonschema2md-0.2.0.post1-py3-none-any.whl
| Download URL | jsonschema2md-0.2.0.post1-py3-none-any.whl |
|---|---|
| Size | 8.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b79bbc2c2b102976189842101d6eb9c20a198c9bb66580248d24340e6c9b6e1b
|
|
BLAKE2b-256 checksum How to use checksums |
f6b4b9db9253de36922a48b86bab53e87709583675af473bb0e4c42ad8514b25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.6 CPython/3.9.4 Linux/5.4.0-1043-azure
|
