jaraco.vcs provides classes for inspecting and working with repositories in the Mercurial and Git version control systems (VCS).
The classes provided are designed to use subprocess invocation to leverage the command-line interfaces of the VCS tools hg and git. An in-process RepoManager for Mercurial exists but has been disabled due to issues that arise when run in certain environments (namely setuptools sandboxing).
This project adds support for automatically generating project version numbers from a source code repository under development.
To use this feature, the project must follow the following assumptions:
- Repo tags are used to indicate released versions.
- Tag names are specified as the version only (i.e. 0.1 or v0.1 and not release-0.1)
- Released versions currently must conform to the Version in packaging. Any tags that don't match this scheme will be ignored.
Thereafter, use the RepoManager.get_current_version to determine the version of the local code. If the current revision is tagged with a valid version, that version will be used. Otherwise, the tags in the repo will be searched, the latest release will be found, and the function will infer the upcoming release version.
For example, if the repo contains the tags 0.1, 0.2, and 0.3 and the repo is not on any of those tags, get_current_version will return '0.3.1dev' and get_current_version(increment='0.1') will return '0.4dev'.
Example:
>>> import jaraco.vcs
>>> jaraco.vcs.repo().get_current_version()
'9.0.1.dev0'