ledgercore documentation
Welcome to the ledgercore documentation.
ledgercore is a small, typed Python library for projects that store structured
records as files. It provides reusable primitives for atomic writes, YAML front
matter, deterministic JSON/YAML storage, safe relative paths, config discovery,
numeric IDs, and cross-ledger references.
Installation
pip install ledgercore
Requirements: Python 3.10+, PyYAML.
Quick start
See the project README for a hands-on introduction.
Documentation index
Contents
- API reference
ledgercore.configledgercore.atomicledgercore.errorsledgercore.frontmatterledgercore.idsledgercore.ioledgercore.jsonioledgercore.jsonlledgercore.pathsledgercore.manifest,ledgercore.overrides, andledgercore.tomlioledgercore.storage_pathsledgercore.storage_bindingledgercore.migrationledgercore.layoutcompatibility facadeledgercore.path_textledgercore.hashingledgercore.refsledgercore.timeledgercore.yamlio
- Cross-ledger references
- Ledgercore storage
- Release process
- Changelog