philiprehberger-schema-infer 0.2.0

Infer JSON schemas from sample data

philiprehberger-schema-infer

Infer JSON schemas from sample data.

Installation

pip install philiprehberger-schema-infer

Usage

Infer schema from samples

from philiprehberger_schema_infer import infer

samples = [
    {"name": "Alice", "age": 30, "active": True},
    {"name": "Bob", "age": 25, "email": "[e-mail]"},
]

schema = infer(samples)
# {
#   "type": "object",
#   "properties": {
#     "name": {"type": "string", "minLength": 3, "maxLength": 5},
#     "age": {"type": "integer", "minimum": 25, "maximum": 30},
#     "active": {"type": "boolean"},
#     "email": {"type": "string", "format": "email", ...}
#   },
#   "required": ["age", "name"]
# }

Full JSON Schema output

from philiprehberger_schema_infer import to_json_schema

schema = to_json_schema(samples)
# {
#   "$schema": "https://json-schema.org/draft/2020-12/schema",
#   "type": "object",
#   "properties": { ... },
#   "required": [...]
# }

Single value type inference

from philiprehberger_schema_infer import infer_type

infer_type([1, 2, 3])
# {"type": "array", "items": {"type": "integer"}}

Merge schemas

from philiprehberger_schema_infer import merge_schemas

merged = merge_schemas(schema_a, schema_b)

API

Name	Description
infer(samples)	Infer JSON Schema from a list of dicts. Includes minimum/maximum for numbers and minLength/maxLength for strings.
infer_type(value)	Infer schema type for a single value
merge_schemas(a, b)	Merge two schemas into one accepting either
to_json_schema(samples)	Wraps infer() output with $schema URI for draft 2020-12

Development

pip install -e .
python -m pytest tests/ -v

Support

If you find this package useful, consider starring the repository.

License

MIT