docs(readme): a Python example that runs - #97
Merged
Merged
Conversation
The library snippet passed a `filing_meta` it never defined, so it could not run as written. It now loads through FilingSession, which resolves a ticker, accession, LEI or path the way `view` and `serve` do and needs no extra, and names the Arelle-level load_model / to_xbrl_model pair for a host with its own Arelle. The CLI list in Install also gains `view`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
filing_metait never defined. It now loads throughFilingSession, whichxbrlkit.servedeclares as API. That session resolves a ticker,"NVDA 10-Q",cik:accession,lei:or a path the wayviewandservedo, and needs no extra installed. Serializing to holon and TAVI and thefrom_holon_jsonround trip are unchanged.load_model→to_xbrl_model(mx, filing)given aFilingMeta, for a host running its own Arelle.viewamong the CLI commands.The new snippet matches the
/pythonpage in xbrlkit-viewer (RoboFinSystems/xbrlkit-viewer#105).Test plan
tests/test_server_json.py(reads the README's registry line) passes🤖 Generated with Claude Code