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, add a section tool.setuptools-git-versioning with config options, and mark the project version as dynamic.
[build-system]
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning<2", ]
build-backend = "setuptools.build_meta"
[tool.setuptools-git-versioning]
enabled = true
[project]
dynamic = ["version"]
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6125e2f5304e66249159a680803c1be01f51fc8e14697973d2594cb715865827 |
|
MD5 | d7d6e9160927fedc34784b4923e08e56 |
|
BLAKE2b-256 | 5b87de216db8f99e2aac38215c1ef048a2716c805b4a58ce79a66c4a267140f4 |
Hashes for setuptools_git_versioning-1.13.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35828be7b930823f17890193caf0520496cf4751740b49d8daedf4781ef5c70a |
|
MD5 | 747224becb5baf32018035bcedd92403 |
|
BLAKE2b-256 | ce3452996feb6d9317b11640f8f929b3cd2bf0f1af6c5509b0d8c355f4d13a43 |