Skip to content

Release v0.21.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 14 Oct 17:12
· 9 commits to main since this release
v0.21.0
f496116

xbrlkit v0.21.0

This release enhances TAVI serialization with fact location metadata, emitting the draft's fact location alongside a QName set describing where a fact sits in the broader document structure. Documentation also gains a working Python quickstart example.

Key Features & Improvements

  • Fact location in TAVI output (#98) — The serializer now writes the draft's fact location, giving consumers a direct pointer to where each fact originates.
  • QName context set — Each fact is accompanied by a set of QNames describing the surrounding structure it sits in, enabling richer downstream navigation and reconciliation.
  • Round-trip support — xbrlkit/deserialize/tavi.py was updated in step with the serializer so the new fields survive a serialize → deserialize cycle.
  • Runnable README example (#97) — The Python snippet in the README is now a complete, executable example rather than an illustrative fragment.

Notable Technical Changes

  • xbrlkit/model.py and xbrlkit/information_block.py extended to carry and expose fact location and QName set data.
  • Test coverage expanded across test_tavi.py, test_deserialize.py, and test_information_block.py to cover the new serialization fields.
  • server.json and pyproject.toml updated for the 0.21.0 release.

Breaking Changes

⚠️ TAVI output format changed. Serialized TAVI documents now include additional fact location and QName fields. Consumers that perform strict schema validation, exact-match comparisons, or byte-level diffing against TAVI output should expect differences and may need updating. Documents produced by 0.21.0 may not deserialize cleanly with earlier xbrlkit versions.

Bug Fixes

No standalone bug fixes in this release; changes are feature and documentation focused.

Upgrading

Most users can upgrade in place. If you persist or compare TAVI artifacts, regenerate them after upgrading and review any schema or fixture assertions that assume the prior field set.

📊 Release Statistics

  • Commits: 5
  • Files Changed: 10
  • Lines Added: 332
  • Lines Deleted: 76
  • Previous Release: v0.20.9

🔗 Links

🤖 Generated with Claude Code

Assets 2
Loading