Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacksmith15/statham-schema
Statham is a Python Model Parsing Library for JSON Schema.
https://github.com/jacksmith15/statham-schema
json-schema model parsing python serialization
Last synced: 3 months ago
JSON representation
Statham is a Python Model Parsing Library for JSON Schema.
- Host: GitHub
- URL: https://github.com/jacksmith15/statham-schema
- Owner: jacksmith15
- License: mit
- Created: 2019-11-05T12:17:15.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-06T10:19:22.000Z (over 1 year ago)
- Last Synced: 2024-10-21T18:31:19.888Z (3 months ago)
- Topics: json-schema, model, parsing, python, serialization
- Language: Python
- Homepage: https://statham-schema.readthedocs.io/en/latest/
- Size: 426 KB
- Stars: 38
- Watchers: 1
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.com/jacksmith15/statham-schema) [](https://statham-schema.readthedocs.io/en/latest/?badge=latest)
# Statham
`statham` is a Python Model Parsing Library for [JSON Schema]. Read the [documentation](https://statham-schema.readthedocs.io/en/latest/).
This project includes tools for writing and generating extensible Python classes based on [JSON Schema] documents.
## Example Model Definition
`statham` can be used to write JSON Schema documents and their corresponding application-level models in one go:
```python
from typing import List
from statham.schema.elements import Array, Integer, Object, String
from statham.schema.property import Property
class Choice(Object):
choice_text: str = Property(String(maxLength=200), required=True)
votes: int = Property(Integer(default=0))
class Poll(Object):
question: str = Property(String(), required=True)
choices: List[Choice] = Property(Array(Choice), required=True)
```
# Generating python classes
Alternatively, Python models may be generated automatically from an existing schema:
```
statham --input http://example.com/schema.json
```
## Command-line arguments
```
Required arguments:
--input INPUT Specify the path to the JSON Schema to be generated.
If the target schema is not at the root of a document, specify the
JSON Pointer in the same format as a JSON Schema `$ref`, e.g.
`--input path/to/document.json#/definitions/schema`
Optional arguments:
--output OUTPUT Output directory or file in which to write the output.
If the provided path is a directory, the command will derive the name
from the input argument. If not passed, the command will write to
stdout.
-h, --help Display this help message and exit.
```
# Installation
This project requires Python 3.6+ and may be installed using [pip]:
```
pip install statham-schema
```
# Compatibility
See [Compatibility](https://statham-schema.readthedocs.io/en/latest/compatibility.html) for information regarding the currently supported JSON Schema draft and exceptions.
# Development
1. Clone the repository: `git clone [email protected]:jacksmith15/statham-schema.git && cd statham-schema`
2. Initialise git submodules: `git submodule update --init --recursive`
3. Install the requirements: `pip install -r requirements.txt -r requirements-test.txt`
4. Run `pre-commit install`
5. Run the tests: `bash run_test.sh -c -a`
This project uses the following QA tools:
- [PyTest](https://docs.pytest.org/en/latest/) - for running unit tests.
- [PyLint](https://www.pylint.org/) - for enforcing code style.
- [MyPy](http://mypy-lang.org/) - for static type checking.
- [Travis CI](https://travis-ci.org/) - for continuous integration.
- [Black](https://black.readthedocs.io/en/stable/) - for uniform code formatting.
Documentation is written using [Sphinx](https://www.sphinx-doc.org/en/master/).
# License
This project is distributed under the MIT license.
[pip]: https://pip.pypa.io/en/stable/
[JSON Schema]: https://json-schema.org/