Backfills CHANGELOG.md, which was empty despite two prior tags: entries for 0.1.0 (untagged, pinned by commit), 0.2.0, 0.3.0, and this release. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WdVgowYC4LARgvNdNMiuvz
3.2 KiB
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
0.3.1 — 2026-07-19
Fixed
-
Documentation corrected a security claim that did not hold. The module docstring and README stated that this library "calls the guard at every persist gate". That described the intended end state in the present tense. Door A — the only door shipped — is ungated: the package has zero runtime dependencies and calls no guard function before writing to disk. Both places now say so plainly, and state that gating external or untrusted content is the caller's responsibility (
okf.import_bundle, orprepare_input/screen_output) until the persist gates land with Doors B and C.No behavior changed in this release. The correction is published because a consumer read the earlier wording as safe-by-default and would have persisted ungated content on that basis.
0.3.0 — 2026-07-17
Added
- Stable machine-readable error codes.
IngestErrorgained a keyword-onlycodeattribute (default"unspecified"). Roughly 24 codes are documented in theerrors.pydocstrings, and those docstrings are the stability contract. Consumers should assert onexc.value.code, not on message text.
Changed
- Exception message text is explicitly declared unstable. It may change in any
release. Tests matching on message strings (
pytest.raises(match=...)) should migrate to code comparisons.
Notes
- Generic schema shape violations deliberately share the single code
manifest_schema. One code per validation rule would have frozen an unnecessarily large surface. Finer resolution is a separate decision, not an assumed requirement.
0.2.0 — 2026-07-17
Added
- PEP 561 support. The
py.typedmarker ships with the package, so consumers get the inline type hints without a mypy override. IngestResult.stampexposes the spec §5 provenance stamp on the result object.
0.1.0 — 2026-07-16
Phase 1 (Door A) implemented against the normative ingest-spec.md owned by
portfolio-optimiser-commons. Never tagged; consumers pinned the commit
dae0bd1a directly.
Added
- Fail-fast manifest validation (spec §3–§4).
- Spec §5 body renderers as pure functions.
- The
fileconnector (CSV, fail-closed path boundary), thesqlconnector (read-only sqlite, env-resolved credentials), and thehttpconnector behind an explicit per-run network opt-in. - Spec §5 materialization with an in-memory staging collision gate.
- Index maintenance on re-materialization (spec §6).
- The spec §11 golden fixtures, compared byte-for-byte.
- The Door A public surface:
materialize_bundleplus the typed error hierarchy rooted inIngestError.