Skip to main content

setuptools_scm plugin for git archives

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for setuptools-scm-git-archive, version 1.1
Filename, size File type Python version Upload date Hashes
Filename, size setuptools_scm_git_archive-1.1-py2.py3-none-any.whl (3.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size setuptools_scm_git_archive-1.1.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page