Use git repo data for building a version number according PEP-440
Project description
Use git repo data (latest tag, current commit hash, etc) for building a version number according PEP 440.
Features:
Can be installed & configured through both setup.py and PEP 518’s pyproject.toml
Does not require to change source code of the project
Tag-, file-, and callback-based versioning schemas are supported
Templates for tag, dev and dirty versions are separated
Templates support a lot of substitutions including git and environment information
Well-documented
See difference between setuptools-git-versioning and other tools.
Limitations:
Currently the only supported VCS is Git
Only git v2 is supported
Currently does not support automatic exporting of package version to a file for runtime use (but you can use setuptools-git-versioning > file redirect instead)
Documentation
See https://setuptools-git-versioning.readthedocs.io/en/stable/
Contribution Guide
See ./CONTRIBUTING.rst
Install
pyproject.toml
Just add setuptools-git-versioning to build-sytem section of your pyproject.toml, and a section tool.setuptools-git-versioning with config options:
[build-system]
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning<2", ]
build-backend = "setuptools.build_meta"
[tool.setuptools-git-versioning]
enabled = true
And check the package version generated (see command help):
$ python -m setuptools_git_versioning
0.0.1
# or
$ setuptools-git-versioning
0.0.1
setup.py
Just add setuptools-git-versioning to setup_requires argument of setuptools.setup function call, and then add new argument setuptools_git_versioning with config options:
import setuptools
setuptools.setup(
...,
setuptools_git_versioning={
"enabled": True,
},
setup_requires=["setuptools-git-versioning<2"],
)
And check the package version generated (see command help):
$ python setup.py --version
0.0.1
# or
$ python -m setuptools_git_versioning
0.0.1
# or
$ setuptools-git-versioning
0.0.1
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for setuptools-git-versioning-1.13.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fde1a7cb3b2566979e5651cfca0d33cd5a82771711cd38a056216391936cf0ff |
|
MD5 | 2a10188780a3b50a16edc0bed09ed43f |
|
BLAKE2b-256 | 6992dc048ec75e81dca38ff013b48cfb4d9fb54810bf5a56abd4e3c8d5574632 |
Hashes for setuptools_git_versioning-1.13.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 648481f7e1e9e12ccd2b069d616b909a338b4223956319649351751cbc0207f4 |
|
MD5 | 88c928ce55c961de696b9c2ecb73d4fb |
|
BLAKE2b-256 | 28a420e721bb6ee32085a4f90101dee6fe9628b5baaf06bd0e326b63939c7ead |