VersionGit

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)

How the documentation is structured

Documentation is split into four categories, accessible from links in the side-bar.

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

How-to Guides

Practical step-by-step guides for the more experienced user.

Explanations

Explanation of how the library works and why it works that way.

Reference

Technical reference material, for classes, methods, APIs, commands, and contributing to the project.

About the documentation

Why is the documentation structured this way?