pykvd

Python bindings for the KVD key-value document format, built on kvd-rs via PyO3 and maturin.

Install (from a built wheel)

pip install pykvd

Usage

import pykvd

# Parse KVD into plain Python objects.
doc = pykvd.loads("app:\n  port: 8080\n")
assert doc == {"app": {"port": 8080}}

# Serialize Python objects to canonical KVD.
pykvd.dumps({"app": {"port": 8080}})

# Normalize/validate a KVD document to its canonical form.
pykvd.canonical("app:\n  port: 8080")

# Verify a document against a schema document.
pykvd.verify("port: 8080\n", "port: int\n")

# Check a schema document is well-formed.
pykvd.validate_schema("port: int\n")

# Structural editing with spec 8.5 paths.
pykvd.get("app:\n  port: 8080\n", "app.port")
pykvd.set("app:\n  port: 8080\n", "app.port", 9090)
pykvd.remove("app:\n  port: 8080\n", "app.port")
pykvd.remove("a:\n  b:\n    c: 1\n", "a.b.c", recursive=True)

Type notes:

• dumps accepts dicts, lists, tuples (as lists), str, int, float, bool, and None. Integers must fit in u64; larger values raise KvdError.
• Int literals beyond u64 parse but come back from loads as strings.
• The document root must be a mapping (spec 4).

Errors:

• KvdError (a ValueError) for parse and serialization failures.
• SchemaError (a KvdError) for verification failures and malformed schemas.
• OpError (a KvdError) for bad operation paths. Missing keys raise KeyError and out-of-range indices raise IndexError.

Development

pip install maturin pytest
PYO3_USE_ABI3_FORWARD_COMPATIBILITY=1 maturin develop
pytest tests/

License

MIT