https://github.com/pypa/setuptools-scm
the blessed package to manage your versions by scm tags
https://github.com/pypa/setuptools-scm
metadata packaging python version-control
Last synced: 2 days ago
JSON representation
the blessed package to manage your versions by scm tags
- Host: GitHub
- URL: https://github.com/pypa/setuptools-scm
- Owner: pypa
- License: mit
- Created: 2015-07-01T17:57:56.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2025-12-08T18:48:25.000Z (5 days ago)
- Last Synced: 2025-12-11T06:36:49.385Z (3 days ago)
- Topics: metadata, packaging, python, version-control
- Language: Python
- Homepage: https://setuptools-scm.readthedocs.io/en/latest/
- Size: 2.94 MB
- Stars: 928
- Watchers: 25
- Forks: 228
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- best-of-python-dev - GitHub - 6% open · ⏱️ 30.11.2025): (Build Tools)
README
# setuptools-scm
[](https://github.com/pypa/setuptools-scm/actions/workflows/python-tests.yml)
[](https://setuptools-scm.readthedocs.io/en/latest/?badge=latest)
[ ](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
```
For further configuration see the [documentation].
[setuptools-scm]: https://github.com/pypa/setuptools-scm
[documentation]: https://setuptools-scm.readthedocs.io/
[git-archive-docs]: https://setuptools-scm.readthedocs.io/en/stable/usage/#builtin-mechanisms-for-obtaining-version-numbers
## 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.
!!! note "Legacy Setuptools Support"
While setuptools-scm recommends setuptools >=80, it maintains compatibility with setuptools 61+
to support legacy deployments that cannot easily upgrade. Support for setuptools <80 is deprecated
and will be removed in a future release. This allows enterprise environments and older CI/CD systems
to continue using setuptools-scm while still encouraging adoption of newer 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].
[PSF Code of Conduct]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
## Security Contact
To report a security vulnerability, please use the
[Tidelift security contact](https://tidelift.com/security).
Tidelift will coordinate the fix and disclosure.