Skip to main content

Official UMF Python support

umf-core provides the umf import namespace for the current UMF language. The authored spec/metamodel/umf.yaml generates the packaged JSON Schemas, portable constraint programs and Python shape data. Pydantic provides access models; it does not define a competing format. Consumer extensions and execution policies remain in consumer repositories.

Install the qualified release wheel:

pip install https://github.com/DocumentDrivenDX/umf/releases/download/umf-v0.5.1/umf_core-0.10.0-py3-none-any.whl

The release URL above identifies the existing published Python artifact. The development source builds a platform-specific native Rust extension instead:

rustup toolchain install 1.90.0
pip install ./python

Building from a checkout or source distribution requires Cargo/Rust 1.90.0 and the locked Cargo dependencies. An installed native wheel does not require Cargo, Node, Bun or V8. Native import failures are explicit; there is no semantic fallback. Pydantic remains the Python access-model dependency. This development change does not publish or replace the release linked above.

The GitHub release and its checksums identify the distributed wheel. PyPI publication is not configured. The separately distributed experimental umf_access host adapter is not required to read or validate UMF documents.

Development candidate distribution version 0.10.2 is distinct from the UMF document/core version 0.10.0. The existing 0.10.0 pure-Python wheel linked above is metadata-only for native execution and does not provide the single-SET action runtime. The source package now exposes create_action_engine, prepare_single_set_action, admit_generated_action_invocation, and admit_generated_record_values; their bounded admission profile is specified by CONTRACT-906. No installation URL for the 0.10.2 candidate native wheel is listed until its platform-specific release assets are published and qualified.

from umf import read_document, validate_document, write_document

document = read_document('''
umf: "0.10.0"
id: orders
vocabularies: {}
modules: []
''', format="yaml")
result = validate_document(document)
assert result.valid and result.complete
# Unknown or unregistered extension meaning can instead make complete false.
text = write_document(document, format="yaml")
assert read_document(text, format="yaml").to_dict() == document.to_dict()

Use canonical camelCase property names when constructing models. to_dict() preserves unknown content and field presence; checked_copy() revalidates mutable model state. Current APIs accept core 0.10.0; retired core dispatch and upgrade/rollback paths are removed. Structural checks and ordered core semantic constraints use generated data through bounded generic interpreters. Installed Python and TypeScript share 139 frozen conformance vectors; this is not a claim of parity for every TypeScript adapter or native execution API.

Unknown vocabulary versions, labels and qualifiers remain serializable and make interpretation incomplete. Consumers must refuse execution when their binding cannot interpret required semantics. Exact numeric token carriers, UUID/128-bit carriers, explicit null and omission retain their separate meanings.

Extensions register explicitly through Registry and Extension with exact versions, permitted scopes, a JSON Schema and optional semantic callback. Callbacks receive copies; schema references must be local. Documents never authorize loading code or fetching schemas. schema_validator() is reusable for consumer-owned schemas and honors their declared dialect.

The R2 Rust-backed production hosts and their resource controls are described in bindings/core/README.md. Ordinary UMF values retain the portable safe-number/UTF-16 profile. Standalone Python consumer-schema validation uses a separate native Python value profile; exact tested runtime versions and compatibility limits belong to the R2 qualification evidence.

The additive R3 compiler is available as from umf.rust_codegen import CodegenEngine. Construct it with the nine explicit trusted resources described in the binding README. Its snake_case convenience methods cover both generators, access diffing, table deployment/migration compilation and verification, change discovery and row-scope normalization. call() retains the complete semantic result envelope; convenience methods raise UmfCodegenError for semantic failures. Cooperative controls use the same operation context through admission, Rust and result copies. The existing umf_codegen default CLI and its MiniRacer dependency remain until R4.

Run python -m pytest python/tests from the repository root. Build with uv build --project python. The source distribution includes the current generated resources and supports building a wheel without the repository. Release checks install the actual wheel in an isolated environment, compare its packaged resource bytes and replay the shared core conformance corpus.

Metadata

Release files for umf-core 0.10.2

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

Source distribution (sdist)

Source distribution for umf-core 0.10.2
File Size Uploaded Provenance
umf_core-0.10.2.tar.gz 2.7 MB With provenance Details

Built distributions (wheels)

Table of built distributions (wheels) for umf-core 0.10.2
File Interpreter ABI Platform
umf_core-0.10.2-cp311-abi3-manylinux_2_34_x86_64.whl CPython 3.11 abi3 Linux glibc 2.34+ x86-64 Details
umf_core-0.10.2-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details

Total release size: 9.5 MB

Release files / umf_core-0.10.2.tar.gz

Download URL umf_core-0.10.2.tar.gz
Size 2.7 MB
Tags Source
SHA-256 checksum
How to use checksums
90a107aaa507930e1d71c0cf208b77182d06c0bf2a1b13681fd5f7b6ed74cb9d
BLAKE2b-256 checksum
How to use checksums
616072e3a05b2bceccadf48d14eb29451cb55a308a7777cda0cf5a3e0e835969
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / umf_core-0.10.2-cp311-abi3-manylinux_2_34_x86_64.whl

Download URL umf_core-0.10.2-cp311-abi3-manylinux_2_34_x86_64.whl
Size 3.6 MB
Tags CPython 3.11 Linux glibc 2.34+ x86-64 abi3
SHA-256 checksum
How to use checksums
708f967747b0539b9ca7b6a5f39d1017eea8ddb1d07cd62f4f46592e088f6f39
BLAKE2b-256 checksum
How to use checksums
69331fdaa7a98acc16db799a1eb71945c4c2e78af150fb308b54f111533366ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / umf_core-0.10.2-cp311-abi3-macosx_11_0_arm64.whl

Download URL umf_core-0.10.2-cp311-abi3-macosx_11_0_arm64.whl
Size 3.3 MB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
99ff1d1250c613a7b65bdd4dc6cf3ee9fec647e02ec34f8dc5ffb84285b0ac59
BLAKE2b-256 checksum
How to use checksums
922ebbabb2739f1b0c0aa031c928946627129c6cab121e34c71f07634c05a270
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Security for umf-core 0.10.2

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.

Full provenance

All 3 files in this release have been uploaded with provenance metadata.

Select from 3 files

Attestation for umf_core-0.10.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

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.

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