Skip to content
This repository has been archived by the owner on Jun 21, 2024. It is now read-only.

Latest commit

 

History

History
60 lines (46 loc) · 2.59 KB

README.rst

File metadata and controls

60 lines (46 loc) · 2.59 KB

VersionGit

Code CI Docs CI Test Coverage Latest PyPI version CC0-1.0 License

Warning

This has been deprecated in favour of setuptools_scm and is no longer maintained

VersionGit is a tool for managing the version number of Python modules, removing the need to update an embedded version string whenever a Git tag is made, and providing sensible development version numbers too. It does this by storing a single file in the source repo that reads the version from git describe or git archive keywords. At build time, this file is modified in the distribution to contain a static version number to be used in preference to this. This tool is inspired by versioneer, but has a vastly reduced feature set so that the code stored in each module is minimal.

PyPI pip install versiongit
Source code https://github.com/dls-controls/versiongit
Documentation https://dls-controls.github.io/versiongit
Changelog https://github.com/dls-controls/versiongit/blob/master/CHANGELOG.rst

License

To make VersionGit easier to embed, all its code is dedicated to the public domain. The _version_git.py that it creates is also in the public domain. Specifically, both are released under the Creative Commons "Public Domain Dedication" license (CC0-1.0)

See https://dls-controls.github.io/versiongit for more detailed documentation.