umf

Build with UMF.

Validate, inspect and translate schemas with the shared Rust engine. Use it from the CLI, Python, Node/Bun or browser WASM.

UMF 0.10.13 is the software release. Documents use the 0.10.0 core format. Extension and workflow profiles have their own versions.

Install 0.10.13

Python

Use Python 3.11–3.14. Wheels are available for Linux x86-64 and arm64 (glibc 2.34+) and macOS arm64.

python -m pip install umf-core==0.10.13 \
  umf-codegen==0.10.13 umf-access==0.10.13
Python package guide

Node, Bun and browsers

Download the SDK archive for Linux x86-64, Linux arm64 or macOS arm64. Install the local archive as @umf/core. This example uses macOS arm64. For the web, use the bundled @umf/core/runtime/wasm entry.

npm install ./umf-sdk-0.10.13-macos-aarch64.tgz
SDK archives · Native and WASM setup

Build from source or run the test suite →

Read, validate and write a document

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
print(write_document(document, format="json"))

Validation reports both validity and completeness. If the registry cannot interpret an extension, it can preserve the content and report partial understanding.

Generate typed Python access

Generate a client from your UMF schema for typed models, queries and action calls. Use the same application API with table and ontology bindings. Supply a compatible host transport for execution.

For the available PostgreSQL operations and lifecycle limits, check the access contract and the qualification for the host you intend to use.

Find a schema, adapter or behavior definition