Skip to main content

covenant-md (Python SDK)

Python SDK for COVENANT.md, the design contract layer for AI agent skills. Alpha: Parser and validator at the Runtime conformance tier, producing identical verdicts to the TypeScript-compatible reference core on the shared spec/fixtures/ suite.

pip install covenant-md
from covenant_md import parse_file, validate_covenant

data = parse_file("path/to/COVENANT.md")
result = validate_covenant("path/to/COVENANT.md")
# result -> {"valid": True, "errors": [], "warnings": [...]}

What it covers

  • Frontmatter parsing (YAML).
  • JSON Schema structural validation (the canonical schema is bundled).
  • Conformance rules from docs/COVENANT.md §Conformance:
    • Required fields, kebab-case name, semver version, stability enum.
    • covenant_version handling per §Versioning (reject unrecognised majors, warn on newer minor under a recognised major, ignore unknown fields under known sections).
    • interface.surface[*].accepts and returns cross-references against contracts.inputs / contracts.outputs.
    • quality.fixtures[*].operation cross-references against interface.surface; quality.fixtures[*].input keys against contracts.inputs.

The contract-driven test runner, lint heuristics, semantic diff, and dependency graph (Full tier) are not yet implemented in Python and remain in @covenant-md/core.

Conformance parity

The test suite at sdks/python/tests/test_conformance.py runs the Python validator against the same spec/fixtures/ the JavaScript core passes and asserts identical verdicts.

Licence: MIT.

Metadata

Release files for covenant-md 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for covenant-md 0.1.0
File Size Uploaded Provenance Actions
covenant_md-0.1.0.tar.gz 9.1 kB Without provenance Details for covenant_md-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for covenant-md 0.1.0
File Interpreter ABI Platform Actions
covenant_md-0.1.0-py3-none-any.whl Python 3 none any Details for covenant_md-0.1.0-py3-none-any.whl

Total release size: 17.1 kB

Release files / covenant_md-0.1.0.tar.gz

Download URL covenant_md-0.1.0.tar.gz
Size 9.1 kB
Tags Source
SHA-256 checksum
How to use checksums
bf18b39db078c00a0c85ca118967c6895994f901fb54e914965f8bd6b1d476de
BLAKE2b-256 checksum
How to use checksums
e0b3853369dae4f2dbd25fce61ab8756e003cdb3da537075a7554665cbe72514
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.3

Release files / covenant_md-0.1.0-py3-none-any.whl

Download URL covenant_md-0.1.0-py3-none-any.whl
Size 8.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a4dde5f100d0e21e37969d868c1cf83cc23489e4a1eac34c4f11498cdd7bea4e
BLAKE2b-256 checksum
How to use checksums
49a3e2e5fbb7bcdb49fa6490cf872e2054662863719addd5031fe82c7f21ed12
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.3

Security for covenant-md 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page