Versioneer¶

https://stackoverflow.com/questions/53724616/update-version-number-with-versioneer-and-github

versioneer will get the version number from git tag + state of the repository.

https://jacobtomlinson.dev/posts/2020/versioning-and-formatting-your-python-code/

install¶

mamba install versioneer -y

Python package version settings¶

Option 1: versioneer (old way)

• versioneer install --vendor: generateversioneer.py and _version.py files directly into project's source tree

• _version.py dynamically asks the VCS for version information at import time

• for source distributions, it replaces the dynamic _version.py with a static one containing the computed version

• requires setup.py, setup.cfg/pyproject.toml

• versioneer.py in project folder and _version.py in base folder

Option 2: setuptools_scm

• More modern, works cleanly with pyproject.toml, Git-based, zero-config

versioneer vs setuptools-smc¶

• https://setuptools-git-versioning.readthedocs.io/en/stable/comparison.html

• https://rse.shef.ac.uk/blog/2023-09-18-python-packaging/#:~:text=Setuptools%2Dscm,on%20now%20deprecated%20setup.py%20.

• https://discuss.python.org/t/how-to-single-source-a-packages-version-when-publishing-to-pypi-using-github-action/50982/17

step 1: create setup.py¶

from setuptools import setup
import versioneer

setup(
    version=versioneer.get_version(),
    cmdclass=versioneer.get_cmdclass(),
)

step 2: create setup.cfg¶

Still not support pyproject.toml

[versioneer]
VCS = git
style = pep440
versionfile_source = pkg/_version.py
versionfile_build = pkg/_version.py
tag_prefix =
parentdir_prefix = pkg-

step 3: create pkg/__init__.py¶

run versioneer install --vendor