refactor: make version number dynamic #41
Merged
Conversation
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
This makes `pyproject.toml` the single source of truth for the current version number. The module uses the standard `importlib` to pull the version number, and Sphinx now pulls from that variable when building docs.
bsoyka
added
area:documentation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the version management system to use pyproject.toml as the single source of truth for version numbers. The changes eliminate hardcoded version strings and use Python's standard importlib.metadata to dynamically retrieve the version.
- Replaces hardcoded version string with dynamic version retrieval using
importlib.metadata - Updates Sphinx documentation configuration to use the dynamically retrieved version
- Removes version duplication across the codebase
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| advent_of_code_ocr/init.py | Implements dynamic version retrieval using importlib.metadata instead of hardcoded version string |
| docs/conf.py | Updates Sphinx configuration to import and use the dynamic version from the package |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This also includes adding the `toml` lib as a dev dependency (in uv, Tox, and Mypy configs).
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.
This makes
pyproject.tomlthe single source of truth for the current version number. The module uses the standardimportlibto pull the version number, and Sphinx now pulls from that variable when building docs.