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 exporting version to file for runtime use
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 part of your pyproject.toml
[build-system]
requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning", ]
build-backend = "setuptools.build_meta"
[tool.setuptools-git-versioning]
enabled = true
setup.py
Just add setuptools-git-versioning to setup_requires part of your setup.py
import setuptools
setuptools.setup(
...,
setuptools_git_versioning={
"enabled": True,
},
setup_requires=["setuptools-git-versioning"],
)
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.9.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a96b0b9304c291bf516cda9cb8670c990d04f1801544ff0488f51ec962a94ffe |
|
MD5 | b78b723645bae53ec17b32f10548611b |
|
BLAKE2b-256 | e053484b9c6e16eba20f294aa1cf7d0e624bcdbcaa142aad5d1feb3d254b6cae |
Hashes for setuptools_git_versioning-1.9.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3dbc010d088b127bb27d12e35930cca3c6f87781c7ca6960bbfc2319bea52394 |
|
MD5 | cc919642de074b3f6a55473bd7f219fa |
|
BLAKE2b-256 | 5c38dfd78ea6105156f28e15a17b7f9e5a800197abc5143ff0d3dfd0554e9691 |