pygitversion 0.1.6

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','setuptools>40.8.0','wheel'] to the key.

3. Ensure that __init__.py contains the correct semantic __version__ specifier.

4. In setup.py, add the following:

   import pygitversion
   pygitversion.write_git_info_file(<your_installed_package_name>, __file__)
   
   Note that if your package resides in a ``src/`` folder, you'll have to use::
   
   pygitversion.write_git_info_file(<your_installed_package_name>, __file__, "src")

5. Ensure the package has a MANIFEST.in, and that it includes <package>/GIT_INFO.

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

   import pygitversion
   pygitversion.construct_version_info(<package_name>)

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

   import pygitversion
   GIT_VERSION = pygitversion.construct_version_info(__name__)

Development

To run the all tests run:

tox

Changelog

0.1.0 (2019-09-04)

• First release on PyPI.