Skip to main content
Version: 2.15 (deprecated)

setuptools-scm

A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm).

Backend: pants.backend.experimental.python

Config section: [setuptools-scm]

Basic options​

None

Advanced options​

console_script​

--setuptools-scm-console-script=<str>
PANTS_SETUPTOOLS_SCM_CONSOLE_SCRIPT
pants.toml
[setuptools-scm]
console_script = <str>
default: None

The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.

entry_point​

--setuptools-scm-entry-point=<str>
PANTS_SETUPTOOLS_SCM_ENTRY_POINT
pants.toml
[setuptools-scm]
entry_point = <str>
default: setuptools_scm

The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.

extra_requirements​

--setuptools-scm-extra-requirements="['<str>', '<str>', ...]"
PANTS_SETUPTOOLS_SCM_EXTRA_REQUIREMENTS
pants.toml
[setuptools-scm]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
default: []

Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.

interpreter_constraints​

--setuptools-scm-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_SETUPTOOLS_SCM_INTERPRETER_CONSTRAINTS
pants.toml
[setuptools-scm]
interpreter_constraints = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "CPython>=3.7,<4"
]

Python interpreter constraints for this tool.

lockfile​

--setuptools-scm-lockfile=<str>
PANTS_SETUPTOOLS_SCM_LOCKFILE
pants.toml
[setuptools-scm]
lockfile = <str>
default: <default>

Path to a lockfile used for installing the tool.

Set to the string <default> to use a lockfile provided by Pants, so long as you have not changed the --version and --extra-requirements options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by [python].invalid_lockfile_behavior). See https://github.com/pantsbuild/pants/blob/release_2.15.2/src/python/pants/backend/python/subsystems/setuptools_scm.lock for the default lockfile contents.

Set to the string <none> to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds and supply-chain security.

To use a custom lockfile, set this option to a file path relative to the build root, then run /home/josh/work/scie-pants/dist/pants generate-lockfiles --resolve=setuptools-scm.

Alternatively, you can set this option to the path to a custom lockfile using pip's requirements.txt-style, ideally with --hash. Set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

version​

--setuptools-scm-version=<str>
PANTS_SETUPTOOLS_SCM_VERSION
pants.toml
[setuptools-scm]
version = <str>
default: setuptools-scm==6.4.2

Requirement string for the tool.

Deprecated options​

None

None