setuptools-git-versioning

Automatically set package version using git tag/hash

Compairing with other packages

Installation

No need.

Adding setup_requires=['setuptools-git-versioning'] somewhere in setup.py will automatically download the latest version from PyPi and save it in the .eggs folder when setup.py is run.

Usage

To just use the default templates for versioning:

setuptools.setup(
    ...
    version_config=True,
    ...
    setup_requires=['setuptools-git-versioning'],
    ...
)

Changing templates (also shows the defaults):

setuptools.setup(
    ...
    version_config={
        "template": "{tag}",
        "dev_template": "{tag}.dev{ccount}+git.{sha}"
        "dirty_template": "{tag}.dev{ccount}+git.{sha}.dirty",
        "starting_version": "0.0.1",
        "version_callback": None,
        "version_file": None,
        "count_commits_from_version_file": False
    },
    ...
    setup_requires=['setuptools-git-versioning'],
    ...
)

Templates

• template: used if no untracked files and latest commit is tagged

• dev_template: used if no untracked files and latest commit isn't tagged

• dirty_template: used if untracked files exist or uncommitted changes have been made

• starting_version: static value, used if not tags exist in repo

• version_callback: variable or callback function to get version instead of using starting_version

• version_file: path to VERSION file, to read version from it instead of using static_version

• count_commits_from_version_file: True to fetch version_file last commit instead of tag commit, False overwise. Example:

  You have a project there tags are added to master branch only (e.g. '1.0.0').
  But you also wish to build development version (e.g. '1.0.0.dev0') from each commit to dev branch.
  But you don't want neither setup tag with CI/CD for every commit to dev branch, nor set such tags manually.
  So just fill up version_file, set count_commits_from_version_file to True and that's all.

Format Options

• {tag}: Latest tag in the repository

• {ccount}: Number of commits since last tag or last version_file commit (see count_commits_from_version_file)

• {sha}: First 8 characters of the sha hash of the latest commit

• {branch}: Current branch name