setuptools-git-version-cc

Automatically set package version from Git using Conventional Commit standard.


License
MIT
Install
pip install setuptools-git-version-cc==2.0.1

Documentation

setuptools-git-version

Automatically set package version from Git.

Introduction

Instead of hardcoding the package version in setup.py like:

setup(
    name='foobar',
    version='1.0',
    ...)

this package allows to extract it from the underlying Git repository:

setup(
    name='foobar',
    version_cc='{version}',
    setup_requires=['setuptools-git-version-cc'],
    ...)

Fields

setuptools-git-version-cc provides a version number with this format:

where each component is computed using the Conventional Commits (CC). It is important to follow the structure of the commit message specified in the standard (see https://www.conventionalcommits.org/en/v1.0.0-beta.2/). The following fields of the version are computed as follows

  • major: Incresed when the type of the commit is breaking (not BREAKING CHANGE as stated in the CC standard). This implies a breaking change in e.g. the interfaces. Numbering starts with 1.
  • minor: Incresed when the type of the commit is feat (new feature added to the code)
  • patch: Incresed when the type of the commit is fix (i.e. bugfix)
  • release: Increased when a type affects non production code (chore, ci, test...)

Implementation Details

setuptools-git-version uses the following git command to obtain commit information:

git log --reverse --pretty=oneline

The script will parse all the messages and compute the version according to the rules specified above

Deployment to PyPi

In order to deploy to PyPi

# Install twine if you do not have it already
pip install twine

# Update setuptools
python3 -m pip install --user --upgrade setuptools wheel

# Create the distribution wheel
python3 setup.py sdist bdist_wheel

# Upload the distribution wheels to the PyPi repo
python3 -m twine upload dist/*

More details on deployment can be found at https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives