Repository navigation
chore: bump version sourcing from package metadata and refresh docs - #8
Merged
Merged
Conversation
- Switch `__version__` to read from installed package metadata via `importlib.metadata.version`, so PyPI/installed copies report the same version as `pyproject.toml` instead of a hardcoded literal - Replace static status badge in README with live PyPI version and Python-version badges, and add a `hqdata` CLI snippet so users know how to populate a local snapshot before running `hqbacktest run` - Note in `docs/cli.md` that the bundled `moving_average.toml` requires a matching `hqdata` snapshot or it raises `SnapshotFileMissingError` with exit code 2 - Ship the previously referenced `configs/moving_average.toml` example so the README/CLI instructions are runnable out of the box, and ignore the generated `results/` directory
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.
__version__to read from installed package metadata viaimportlib.metadata.version, so PyPI/installed copies report the same version aspyproject.tomlinstead of a hardcoded literalhqdataCLI snippet so users know how to populate a local snapshot before runninghqbacktest rundocs/cli.mdthat the bundledmoving_average.tomlrequires a matchinghqdatasnapshot or it raisesSnapshotFileMissingErrorwith exit code 2configs/moving_average.tomlexample so the README/CLI instructions are runnable out of the box, and ignore the generatedresults/directory