pydantic-schema-sync 0.1.0

Synchronise Pydantic model schemas with JSONSchema files

pydantic-schema-sync

Synchronise Pydantic model schemas with JSONSchema files.

Usage

Python

From a model class:

from pydantic_schema_sync import sync_schema

# Using field alias (default)
sync_schema(model=Foo, schema_path="schema.json")

# Unaliased field
sync_schema(model=Foo, schema_path="schema.json", mjs_kwargs={"by_alias": False})

From a path to a model class:

from pydantic_schema_sync import sync_schema_from_path

# This path must be in an installed package
path_to_model_cls = "pydantic_schema_sync.cli.SyncCLI"
sync_schema_from_path(model=path_to_model_cls, schema_path="schema.json")

CLI

To serialise the schema of the model named ExampleModel (in the package my_pkg's module my_module) to the file test.json, passing the by_alias=False param to .model_json_schema():

model-schema-sync \
  --model my_pkg.my_module.ExampleModel \
  --schema_path test.json \
  --mjs_kwargs '{"by_alias":false}'