datacontract-specification
v1.2.3The Pydantic Model of the Data Contract Specification
15 KB Python 3.10+ py3-none-anyMIT License2 deps
$ uv add datacontract-specificationData Contract Specification (Python)
The pip module datacontract-specification to read and write YAML files using the Data Contract Specification. The pip module was extracted from the Data Contract CLI, which is its primary user.
The version number of the pip module corresponds to the version of the Data Contract Specification it supports.
Version Mapping
| Data Contract Specification Version | Pip Module Version |
|---|---|
| 1.2.0 | >=1.2.0 |
| 1.1.0 | >=1.1.0 |
Note: We mirror major and minor version from the Data Contract Specification to the pip module, but not the patch version!
Installation
pip install datacontract-specification
Usage
from datacontract_specification.model import DataContractSpecification
# Load a data contract specification from a file
data_contract = DataContractSpecification.from_file('path/to/your/data_contract.yaml')
# Print the data contract specification as a YAML string
print(data_contract.to_yaml())
from datacontract_specification.model import DataContractSpecification
# Load a data contract specification from a string
data_contract_str = """
dataContractSpecification: 1.2.0
id: urn:datacontract:checkout:orders-latest
info:
title: Orders Latest
version: 2.0.0
description: |
Successful customer orders in the webshop.
All orders since 2020-01-01.
Orders with their line items are in their current state (no history included).
owner: Checkout Team
status: active
contact:
name: John Doe (Data Product Owner)
url: https://teams.microsoft.com/l/channel/example/checkout
"""
data_contract = DataContractSpecification.from_string(data_contract_str)
# Print the data contract specification as a YAML string
print(data_contract.to_yaml())
Development
uv sync --all-extras
Release
- Change version number in
pyproject.toml - Run
./releasein your command line - Wait for the releases on GitHub, PyPi and PyPi (test)
Details
- Version
- 1.2.3
- License
- MIT License
- Python
- >=3.10
- Maintainer
- Jochen Christ <[email protected]>, Stefan Negele <[email protected]>, Simon Harrer <[email protected]>
Links
Maintainers
- Jochen Christ · [email protected]
- Stefan Negele · [email protected]
- Simon Harrer · [email protected]