eshwen/pyproject-version-sync

Pre-commit hook to align the pyproject.toml version with the latest tag in the repo

pyproject-version-sync's Issues

Add package to PyPI

For discoverability

Test with more Python versions

In theory, this package should be compatible with Python <=3.9, and >=3.11. But I should test, just in case

Then I can run any CI pipelines with these additional Python versions, extend the Python version range in pyproject.toml, as well as the Python badge in the README to showcase compatibility

With Python >= 3.11, tomli is included in the standard library. So maybe I can put constraints on the dependency to only install for <= 3.10

Write unit tests

This project is pretty simple. But nonetheless, unit tests should be written to validate the functionality

Allow a pyproject.toml file to be passed by the user

The hook is currently hardcoded to only run over the pyproject.toml file in the root of the repo

Add functionality to allow the user to pass a path to pyproject.toml file elsewhere in the repo, e.g., if it's nested in subdirectory instead of at the root

Improve logic for extracting the tag version from git

Get it to handle more complex tag naming conventions, e.g., v1.0.0-a. Perhaps also add argument to allow the user to keep the v prefix if their tag starts with a v

Rename project

Rename pyproject-version-check to pyproject-version-sync. Sounds better, I think. Update IDs, names, executables, etc., and also usages in repos