| Port variant | v13 |
| Summary | Package to manage versions by scm tags (3.13) |
| Package version | 8.1.0 |
| Homepage | https://pypi.org/project/setuptools-scm/ |
| Keywords | python |
| Maintainer | Python Automaton |
| License | Not yet specified |
| Other variants | v12 |
| Ravenports | Buildsheet | History |
| Ravensource | Port Directory | History |
| Last modified | 14 JAN 2025, 19:34:39 UTC |
| Port created | 20 APR 2020, 15:00:59 UTC |
| 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 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 61 or later. 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>=64", "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] ``` 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/ ## 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]. [PSF Code of Conduct]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md ## Security Contact |
| Build (only) |
python313:dev:std python-pip:single:v13 autoselect-python:single:std |
| Build and Runtime | python313:primary:std |
| Runtime (only) |
python-packaging:single:v13 python-setuptools:single:v13 |
| main | mirror://PYPIWHL/a0/b9/1906bfeb30f2fc13bb39bf7ddb8749784c05faadbd18a21cf141ba37bff2 |
| python-borgbackup:v13 | Deduplicated, encrypted, compressed backups (3.13) |
| python-compreffor:v13 | CFF subroutinizer for fontTools (3.13) |
| python-freetype-py:v13 | Freetype python bindings (3.13) |
| python-lazy-object-proxy:v13 | Fast and thorough lazy object proxy (3.13) |
| python-psautohint:v13 | Wrapper for Adobe's PostScript autohinter (3.13) |
| python-pyclipper:v13 | Cython wrapper for the AJ Clipper library (3.13) |