setuptools-scm-git-archive 1.0

setuptools_scm plugin for git archives

This is a setuptools_scm plugin that adds support for git archives (for example the ones GitHub automatically generates).

Note that it only works for archives of tagged commits (because git currently lacks a format option equivalent to git describe --tags).

Usage

Add 'setuptools_scm_git_archive' to the setup_requires parameter in your project’s setup.py file:

setup(
    ...,
    use_scm_version=True,
    setup_requires=['setuptools_scm', 'setuptools_scm_git_archive'],
    ...,
)

Create a .git_archival.txt file with the following content:

ref-names: $Format:%D$

Then add this line to the .gitattributes file:

.git_archival.txt  export-subst

Finally, don’t forget to commit these two files.