the blessed package to manage your versions by scm tags
Project description
setuptools_scm
about
setuptools-scm extracts Python package versions from git or
hg metadata instead of declaring them as the version argument
or in an SCM managed file.
Additionally, setuptools-scm provides setuptools
with a list of files that are managed by the SCM
(i.e. it automatically adds all of the SCM-managed files to the sdist).
Unwanted files must be excluded via MANIFEST.in.
pyproject.toml usage
The preferred way to configure setuptools-scm is to author
settings in a tool.setuptools_scm section of pyproject.toml.
This feature requires setuptools 60 or later. First, ensure that setuptools-scm is present during the project's build step by specifying it as one of the build requirements.
[build-system]
requires = [
"setuptools>=60",
"setuptools-scm>=8.0"]
That will be sufficient to require setuptools-scm for projects that support PEP 518 like pip and build.
To enable version inference, you need to set the version
dynamically in the project section of pyproject.toml:
[project]
# version = "0.0.1" # Remove any existing version parameter.
dynamic = ["version"]
[tool.setuptools_scm]
Additionally, a version file can be written by specifying:
[tool.setuptools_scm]
version_file = "pkg/_version.py"
Where pkg is the name of your package.
If you need to confirm which version string is being generated or debug the configuration, you can install setuptools-scm directly in your working environment and run:
$ python -m setuptools_scm
# To explore other options, try:
$ python -m setuptools_scm --help
Interaction with Enterprise Distributions
Some enterprise distributions like RHEL7 ship rather old setuptools versions.
In those cases its typically possible to build by using an sdist against setuptools_scm<2.0.
As those old setuptools versions lack sensible types for versions,
modern setuptools-scm is unable to support them sensibly.
It's strongly recommended to build a wheel artifact using modern Python and setuptools, then installing the artifact instead of trying to run against old setuptools versions.
Code of Conduct
Everyone interacting in the setuptools-scm project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PSF Code of Conduct.
Security Contact
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
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_scm-8.0.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b737bb0f195ae024759188e7080fe15fe6d9353e1b3f6e40b41e4d298f76c147 |
|
| MD5 | beb89a7c4a5ed3fa6b9ecd11e8e32398 |
|
| BLAKE2b-256 | cdce7d8579e32a6cf28bf4a71fb0ea49344cf5508bd5edd8ebd19ccfcb5d8640 |
