setuptools-scm

github ci Documentation Status tidelift

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.

⚠️ 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.

[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.

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]

!!! 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! (In 9.2+, this requires the `simple` extra.) You can now
enable setuptools-scm with just:

```toml title="pyproject.toml"
[build-system]
requires = ["setuptools>=80", "setuptools-scm[simple]>=9.2"]
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:

[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

For further configuration see the documentation.

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.

Security Contact

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Project links

Data verified by PyPI on Sep 1, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (10.2.3)

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for jaraco from gravatar.com jaraco Avatar for jezdez from gravatar.com jezdez Avatar for ronny from gravatar.com ronny

Credits

Author: Ronny Pfannschmidt

GitHub Statistics

Data verified by PyPI on Sep 1, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT

Requires

Python >=3.8

Provides Extra

rich simple toml

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

setuptools_scm-10.2.2.tar.gz (67.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

setuptools_scm-10.2.2-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

Details for the file setuptools_scm-10.2.2.tar.gz.

File metadata

  • Download URL: setuptools_scm-10.2.2.tar.gz
  • Upload date:
  • Size: 67.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for setuptools_scm-10.2.2.tar.gz
Algorithm Hash digest
SHA256 36b5dcef6bbeee0bc76b7756d1b574b3762e2138611a4f18e898f22f1aaee462
MD5 9f098cac97ca5182f2cdc1ad1d83e6cf
BLAKE2b-256 cf0b12b674e0e567b1ecb3b24e3dd7e98b8fff36c4f470319629717c70c66a6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for setuptools_scm-10.2.2.tar.gz:

Publisher: python-tests.yml on pypa/setuptools-scm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file setuptools_scm-10.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for setuptools_scm-10.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 509585ce0628ede1c64ab1e40e7464481fb880c80a388effce9067bf6b2142fe
MD5 e1497c3761dca26398b500c32d0c6561
BLAKE2b-256 9a9d9b504c33edf83f6f09bea186fbd74e42eec8aeaf5821a81dec43cd685478

See more details on using hashes here.

Provenance

The following attestation bundles were made for setuptools_scm-10.2.2-py3-none-any.whl:

Publisher: python-tests.yml on pypa/setuptools-scm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

10.2.3

2 files

This release

10.2.2 This release

2 files

10.2.1

2 files

10.2.0

2 files

10.1.2

2 files

10.1.1

2 files

10.0.5

2 files

10.0.4

2 files

10.0.3

2 files

10.0.2

2 files

Yanked

10.0.1

2 files

Yanked reason: https://github.com/pypa/setuptools-scm/issues/1298 - breaks editable usage

9.2.2

2 files

9.2.1

2 files

9.2.0

2 files

Yanked

9.1.1

2 files

Yanked reason: regression with the auto-enable feature triggering activation when unwanted

Yanked

9.1.0

2 files

Yanked reason: regression where version resolves to 0.0.0 in specific sdists

Yanked

9.0.3

2 files

Yanked reason: regression chain

Yanked

9.0.2

2 files

Yanked reason: regression chain

Yanked

9.0.1

2 files

Yanked reason: regression chain

Yanked

9.0.0

2 files

Yanked reason: 2 unplanned regressions in config parsing and downstream api usage

8.3.1

2 files

8.3.0

2 files

Yanked

8.2.1

2 files

Yanked reason: regression with setuptools compatibility

8.2.0

2 files

8.1.0

2 files

8.0.4

2 files

8.0.3

2 files

8.0.2

2 files

8.0.1

2 files

Yanked

8.0.0

2 files

Yanked reason: python version compatibility issue

7.1.0

2 files

7.0.5

2 files

7.0.4

2 files

7.0.3

2 files

7.0.2

2 files

7.0.1

2 files

Yanked

7.0.0

2 files

Yanked reason: regression with python 3.7 support due to missed dependency

6.4.2

2 files

6.4.1

2 files

6.4.0

2 files

6.3.2

2 files

6.3.1

2 files

Yanked

6.3.0

2 files

Yanked reason: regression due to toml dependencies

Yanked

6.2.0

2 files

Yanked reason: regression due to a discovered setuptools bug

Yanked

6.1.1

2 files

Yanked reason: regression due to issues with dependency processing

Yanked

6.1.0

2 files

Yanked reason: version compatibility bug

Yanked

6.1.0.dev0

2 files

Yanked reason: version compatibility bug

6.0.1

2 files

6.0.0

2 files

5.0.2

8 files

5.0.1

8 files

5.0.0

8 files

4.1.2

8 files

4.1.1

8 files

4.1.0

8 files

4.0.0

8 files

3.5.0

7 files

3.4.3

8 files

3.4.2

8 files

3.4.1

8 files

3.4.0

8 files

3.3.3

8 files

3.3.2

6 files

3.3.1

6 files

3.2.0

6 files

3.1.0

6 files

3.0.6

6 files

3.0.5

6 files

3.0.4

6 files

3.0.2

6 files

3.0.1

6 files

3.0.0

6 files

2.1.0

6 files

2.0.0

6 files

1.17.0

6 files

1.16.2

6 files

1.16.1

6 files

1.16.0

6 files

1.15.7

7 files

1.15.6

8 files

1.15.5

8 files

1.15.4

8 files

Pre-release

1.15.1rc1

8 files

1.15.0

8 files

Pre-release

1.15.0rc1

7 files

1.14.0

7 files

Pre-release

1.14.0rc1

7 files

1.13.1

2 files

1.13.0

2 files

1.12.0

1.11.1

2 files

1.11.0

2 files

1.10.1

3 files

1.10.0

3 files

1.9.0

2 files

1.8.0

3 files

1.7.0

2 files

1.6.0

2 files

1.5.5

1 file

1.5.4

1 file

1.5.3

1 file

1.5.2

2 files

1.5.0

2 files

1.4.1

2 files

1.4.0

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page