Version file¶
Auto generated by setuptools-scm. setuptools-scm recommends not to put the version file within the sdist (tarball .tar.gz).
Later learned readthedocs insists the version be available from the package. So included the version file within the repo
The version file is a generated file. That’s exactly what build plugin were born for! During build, the version file is regenerated.
When kitting, special attention must be paid to this file!
Define location of version file
In pyproject.toml,
[project]
dynamic = [
"optional-dependencies",
"dependencies",
"version",
]
[tool.setuptools.dynamic]
version = {attr = "drain_swamp._version.__version__"}
[tool.pipenv-unlock]
version_file = "src/drain_swamp/_version.py"
Yes it’s defined twice. One is a dotted path other is the relative path
read and write
From version file, get (tag) version
drain-swamp tag
Write semantic version str to version file
scm-version write "0.0.1"
Check and fix semantic version str
drain-swamp pretag "0.0.1.candidate1.post4.dev3"
0.0.1rc1.post4.dev3
python equivalents
>>> from drain_swamp.igor_utils import pretag
>>> is_success, ver = pretag("0.0.1dev1")
>>> ver
'0.0.1.dev1'
>>> from drain_swamp.igor_utils import pretag
>>> is_success, ver = pretag("0.0.1post3dev4")
>>> ver
'0.0.1.post3.dev4'
drain-swamp pretag "0.0.1rc3dev2"
python equivalent
>>> from drain_swamp.igor_utils import pretag
>>> is_success, ver = pretag("0.0.1rc3dev2")
>>> ver
'0.0.1rc3.dev2'
With epoch and local
Notice single quotes to escape the !
drain-swamp pretag '1!0.0.1rc3dev2+gasdfgh.d20240501'
(python equivalent doctest friendly)
>>> from drain_swamp.igor_utils import pretag
>>> is_success, ver = pretag("1!0.0.1rc3dev2+gasdfgh.d20240501")
>>> ver
'0.0.1rc3.dev2'
drain-swamp pretag '1!v0.0.1alpha3dev2+gasdfgh.d20240501'
(python equivalent doctest friendly)
>>> from drain_swamp.igor_utils import pretag
>>> is_success, ver = pretag("1!v0.0.1alpha3dev2+gasdfgh.d20240501")
>>> ver
'0.0.1a3.dev2'
The epoch and local and prepended “v” are stripped. And the remainder is sanitized
See also
- __version__: str¶
The semantic version, e.g. “0.0.1”. This is the full semantic string which can include development, pre and post releases, and release candidates
Aliases –> Unused
