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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f046dbae351bed096882905a14bf7ce9889cb4c151bc3a8d21dae3db282f22e |
|
MD5 | 7bf1b0fe1cae5dea361d43cc6f7492cb |
|
BLAKE2b-256 | e5426750e38b224f12de1007e2696e14e02433343e2f99f22da0758f27c51804 |
Hashes for setuptools_git_versioning-1.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b402217ed91a2b4be63184481a576c71448e4f5acc098c3d9440ed2220249e5e |
|
MD5 | 9ea5c0b3f4446d6fb15ab2a53130b0d2 |
|
BLAKE2b-256 | 2346b1d2418123a6665ff394b72703c47ff0e7fd8337ae866ccd1391bc782e64 |