# Buildsheet autogenerated by ravenadm tool -- Do not edit.
NAMEBASE= python-setuptools-scm
VERSION= 9.2.2
KEYWORDS= python
VARIANTS= v13 v14
SDESC[v13]= Package to manage versions by scm tags (3.13)
SDESC[v14]= Package to manage versions by scm tags (3.14)
HOMEPAGE= https://pypi.org/project/setuptools-scm/
CONTACT= Python_Automaton[python@ironwolf.systems]
DOWNLOAD_GROUPS= main
SITES[main]= PYPIWHL/3d/ea/ac2bf868899d0d2e82ef72d350d97a846110c709bacf2d968431576ca915
DISTFILE[1]= setuptools_scm-9.2.2-py3-none-any.whl:main
DIST_SUBDIR= python-src
DF_INDEX= 1
SPKGS[v13]= single
SPKGS[v14]= single
OPTIONS_AVAILABLE= PY313 PY314
OPTIONS_STANDARD= none
VOPTS[v13]= PY313=ON PY314=OFF
VOPTS[v14]= PY313=OFF PY314=ON
DISTNAME= setuptools_scm-9.2.2.dist-info
GENERATED= yes
[PY313].RUN_DEPENDS_ON= python-packaging:single:v13
python-setuptools:single:v13
[PY313].USES_ON= python:v13,wheel
[PY314].RUN_DEPENDS_ON= python-packaging:single:v14
python-setuptools:single:v14
[PY314].USES_ON= python:v14,wheel
[FILE:3071:descriptions/desc.single]
# setuptools-scm
[github ci]
[Documentation Status]
[![tidelift]](https://tidelift.com/subscription/pkg/pypi-setuptools-scm?utm_source=pypi-setuptools-scm&utm_medium=readme)
## about
[setuptools-scm] extracts Python package versions from `git` or `hg`
metadata
instead of declaring them as the version argument
or in a Source Code Managed (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 the SCM-managed files to the sdist).
Unwanted files must be excluded via `MANIFEST.in`
or [configuring Git archive][git-archive-docs].
> **⚠️ Important:** Installing setuptools-scm automatically enables a
file finder that includes **all SCM-tracked files** in your source
distributions. This can be surprising if you have development files tracked
in Git/Mercurial that you don't want in your package. Use `MANIFEST.in` to
exclude unwanted files. See the [documentation] for details.
## `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 61 or later (recommended: >=80 for best
compatibility).
First, ensure that [setuptools-scm] is present during the project's
build step by specifying it as one of the build requirements.
```toml title="pyproject.toml"
[build-system]
requires = ["setuptools>=80", "setuptools-scm>=8"]
build-backend = "setuptools.build_meta"
```
That will be sufficient to require [setuptools-scm] for projects
that support [PEP 518] like [pip] and [build].
[pip]: https://pypi.org/project/pip
[build]: https://pypi.org/project/build
[PEP 518]: https://peps.python.org/pep-0518/
To enable version inference, you need to set the version
dynamically in the `project` section of `pyproject.toml`:
```toml title="pyproject.toml"
[project]
# version = "0.0.1" # Remove any existing version parameter.
dynamic = ["version"]
[tool.setuptools_scm]
```
!!! note "Simplified Configuration"
Starting with setuptools-scm 8.1+, if `setuptools_scm` (or
`setuptools-scm`) is
present in your `build-system.requires`, the `[tool.setuptools_scm]`
section
becomes optional! You can now enable setuptools-scm with just:
```toml title="pyproject.toml"
[build-system]
requires = ["setuptools>=80", "setuptools-scm>=8"]
build-backend = "setuptools.build_meta"
[project]
dynamic = ["version"]
```
The `[tool.setuptools_scm]` section is only needed if you want to
customize
configuration options.
Additionally, a version file can be written by specifying:
```toml title="pyproject.toml"
[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:
```console
$ python -m setuptools_scm
# To explore other options, try:
$ python -m setuptools_scm --help
```
[FILE:127:distinfo]
30e8f84d2ab1ba7cb0e653429b179395d0c33775d54807fc5f1dd6671801aef7 62975 python-src/setuptools_scm-9.2.2-py3-none-any.whl