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 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.11.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4c083cf7ab3fca54f73f096b7cb07aa7bdc479df0b4adaad8f1519c4a39b812 |
|
MD5 | d3f98a52551da6bfa62d87d2593533c5 |
|
BLAKE2b-256 | e00f073e7dc42256a0458e7eca56e23bcc61bc131e2836b3d4c5ec11e5a5d68d |
Hashes for setuptools_git_versioning-1.11.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6b42fd3ae95c9fa09fd6f2fc495cdb134c0773db2a326db277cc2153ec5e2fc |
|
MD5 | abd6c9726e04384238b6fd47608b4f82 |
|
BLAKE2b-256 | 8412b88e2bdef7c354e5319ebd35af692f5afa1cd8baed89772e4e2d78d420c4 |