fix: report version (#45) + re-run docs & flexible --report-dir (#48) - #54
Merged
Conversation
Closes #45. Add __version__ to the package (sourced from installed package metadata) and surface it as summary.version in the JSON report and a 'Tool version' line in the markdown Run Summary.
…e-verify docs Closes #48. - consistency/explore now accept --report-dir at the subcommand level (in addition to the global option), with the local value taking precedence. The natural 'consistency ... --report-dir DIR' order no longer fails. - README + docs/cli.md: fix wrong --report-dir placement and explore examples, correct the report filename pattern, add a single canonical 'Re-run & Re-verify' section, and describe --seed realistically. - Mention the published docs site in the README.
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
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
Two focused fixes from the #45–#50 batch:
#45 — Tool version in reports
eida_consistency.__version__(sourced from installed package metadata, so it trackspyproject.tomlautomatically).summary.versionin the JSON report and aTool versionline in the markdown Run Summary.#48 — Re-run docs + flexible
--report-dirconsistencyandexplorenow accept--report-dirat the subcommand level too (not only as a global option), with the local value taking precedence. The naturaleida-consistency consistency … --report-dir DIRorder no longer fails with a usage error — the root cause of the issue.README.md,docs/cli.md):--report-dirplacement and theexploreexamples (--latest→ no-arg form).<node>_<YYYYMMDD_HHMMSS>_<seed>.--seedrealistically (does not reproduce an old run; replay the exact window instead).Test plan
uv run pytest— 164 passed--report-diraccepted both before and after the subcommand (consistency+explore)summary.versionin JSON +Tool versionline in markdownmkdocs build --strictpassesCloses #45
Closes #48