PyCharter - Data Contract Management

Documentation

Contract Management

Manage and work with data contracts

Contract Parser

Read and decompose data contract files

Arguments

contract_data

Dict[str, Any]

Contract data as dictionary containing schema, metadata, ownership, governance_rules, coercion_rules, and validation_rules

validate(optional)

booldefault: True

If True (default), validate contract against schema before parsing

Returns

ContractMetadata

ContractMetadata object with decomposed components (schema, metadata, ownership, governance_rules, coercion_rules, validation_rules) and version tracking

from pycharter import parse_contract, parse_contract_file

parse_contract(contract_dict)
parse_contract_file(file_path)

Method: parse_contract(contract_dict, validate=True)

Test API

Request Body (JSON)

POST /api/v1/contracts/parse

Contract Parser - From File

Parse a data contract from an uploaded file (YAML or JSON)

Arguments

file_path

str

Path to contract file (YAML or JSON)

validate(optional)

booldefault: True

If True (default), validate contract against schema before parsing

Returns

ContractMetadata

ContractMetadata object with decomposed components (schema, metadata, ownership, governance_rules, coercion_rules, validation_rules)

from pycharter import parse_contract_file

# Parse contract from file
contract_metadata = parse_contract_file("contract.yaml")
# or
contract_metadata = parse_contract_file("contract.json", validate=True)

Method: parse_contract_file(file_path, validate=True)

Test API

Upload File

POST /api/v1/contracts/parse/upload

Contract Builder

Construct consolidated contracts from separate artifacts

Arguments

artifacts

ContractArtifacts

ContractArtifacts dataclass containing schema (required), coercion_rules (optional), validation_rules (optional), and metadata (optional)

include_metadata(optional)

booldefault: True

Whether to include metadata in the contract

include_ownership(optional)

booldefault: True

Whether to include ownership information

include_governance(optional)

booldefault: True

Whether to include governance rules

Returns

Dict[str, Any]

Consolidated contract dictionary ready for runtime validation, containing schema (with merged coercion/validation rules), coercion_rules, validation_rules, metadata (if included), and versions tracking dictionary

from pycharter import build_contract, ContractArtifacts

artifacts = ContractArtifacts(
    schema={"type": "object", "version": "1.0.0", "properties": {...}},
    coercion_rules={"version": "1.0.0", "age": "coerce_to_integer"},
    validation_rules={"version": "1.0.0", "age": {...}},
    metadata={"version": "1.0.0", "description": "User contract"}
)
contract = build_contract(artifacts)

Method: build_contract(artifacts: ContractArtifacts, include_metadata=True, include_ownership=True, include_governance=True)

Test API

Request Body (JSON)

POST /api/v1/contracts/build

Contract Builder - From Store

Build a consolidated contract from artifacts stored in metadata store with individual version control for each component

Arguments

store

MetadataStoreClient

MetadataStoreClient instance connected to the metadata store

schema_title

str

Schema title/identifier

schema_version(optional)

Optional[str]default: None

Optional schema version (if None, uses latest version)

coercion_rules_title(optional)

Optional[str]default: None

Optional coercion rules title/identifier (if None, uses schema_title)

coercion_rules_version(optional)

Optional[str]default: None

Optional coercion rules version (if None, uses latest version or schema_version)

validation_rules_title(optional)

Optional[str]default: None

Optional validation rules title/identifier (if None, uses schema_title)

validation_rules_version(optional)

Optional[str]default: None

Optional validation rules version (if None, uses latest version or schema_version)

metadata_title(optional)

Optional[str]default: None

Optional metadata title/identifier (if None, uses schema_title)

metadata_version(optional)

Optional[str]default: None

Optional metadata version (if None, uses latest version or schema_version)

Returns

Dict[str, Any]

from pycharter import build_contract_from_store

store = PostgresMetadataStore(connection_string)
store.connect()
contract = build_contract_from_store(
    store=store,
    schema_title="user_schema",
    schema_version="1.0.0",
    coercion_rules_title="user_schema",
    coercion_rules_version="1.0.0",
    validation_rules_title="user_schema",
    validation_rules_version="1.0.0",
    metadata_title="user_schema",
    metadata_version="1.0.0"
)

Method: build_contract_from_store(store, schema_title, schema_version=None, coercion_rules_title=None, coercion_rules_version=None, validation_rules_title=None, validation_rules_version=None, metadata_title=None, metadata_version=None)

Test API

Request Body (JSON)

POST /api/v1/contracts/build

Additional Resources

• Full documentation: See README.md and REFERENCE.md
• Examples: Check the examples/ directory
• API Documentation: Available at /docs when running the API server

from pycharter import parse_contract_file # Parse contract from file contract_metadata = parse_contract_file("contract.yaml") # or contract_metadata = parse_contract_file("contract.json", validate=True)

from pycharter import build_contract, ContractArtifacts artifacts = ContractArtifacts( schema={"type": "object", "version": "1.0.0", "properties": {...}}, coercion_rules={"version": "1.0.0", "age": "coerce_to_integer"}, validation_rules={"version": "1.0.0", "age": {...}}, metadata={"version": "1.0.0", "description": "User contract"} ) contract = build_contract(artifacts)

from pycharter import build_contract_from_store store = PostgresMetadataStore(connection_string) store.connect() contract = build_contract_from_store( store=store, schema_title="user_schema", schema_version="1.0.0", coercion_rules_title="user_schema", coercion_rules_version="1.0.0", validation_rules_title="user_schema", validation_rules_version="1.0.0", metadata_title="user_schema", metadata_version="1.0.0" )