pygitversion 0.1.7

Installation

pip install pygitversion

Usage

The point of pygitversion is to enable you to robustly create your package with exact git version information, rather than just a simple version specifier.

It does not replace the semantic version specifier of your package, but rather complements it. pygitversion provides the tools necessary to always have git information available in a Python package (whether the actual repo is available or not).

To use in your package, follow these steps:

1. If pyproject.toml does not exist in your package, create it.

2. Add the key [build-system] to pyproject.toml, and add requires = ['pygitversion>=0.1.6','setuptools>40.8.0','wheel'] to the key.

3. Ensure that __init__.py contains the correct semantic __version__ specifier (eg. __version__ = 0.1.0).

4. In setup.py, add the following:

   import pygitversion
   pygitversion.write_git_info_file(__file__, <rel_path_to_package>)

5. Ensure the package has a MANIFEST.in, and that it includes at least:

   include <package>/GIT_INFO

6. The git version of the module may then be accessed inside your package by doing:

   import pygitversion
   pygitversion.construct_version_info(my_package_name)

7. It is recommended (but not necessary) that __init__.py contain:

   import pygitversion
   GIT_VERSION = pygitversion.construct_version_info(__name__)

8. It is also recommended to add GIT_INFO to your .gitignore.

Development

To run the all tests run:

tox

Changelog

0.1.0 (2019-09-04)

• First release on PyPI.