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

Backend: <span style="color: purple"><code>pants.backend.experimental.python</code></span> Config section: <span style="color: purple"><code>[setuptools-scm]</code></span>

## Basic options

None

## Advanced options

<div style="color: purple">

### `version`

<code>--setuptools-scm-version=<str></code><br> <code>PANTS_SETUPTOOLS_SCM_VERSION</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>setuptools-scm==6.4.2</code></span>

<br>

Requirement string for the tool.

</div> <br>

<div style="color: purple">

### `extra_requirements`

<code>--setuptools-scm-extra-requirements="['&lt;str&gt;', '&lt;str&gt;', ...]"</code><br> <code>PANTS_SETUPTOOLS_SCM_EXTRA_REQUIREMENTS</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>

<br>

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.

</div> <br>

<div style="color: purple">

### `interpreter_constraints`

<code>--setuptools-scm-interpreter-constraints="['&lt;str&gt;', '&lt;str&gt;', ...]"</code><br> <code>PANTS_SETUPTOOLS_SCM_INTERPRETER_CONSTRAINTS</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "CPython&gt;=3.7,&lt;4" ]</pre></span>

<br>

Python interpreter constraints for this tool.

</div> <br>

<div style="color: purple">

### `lockfile`

<code>--setuptools-scm-lockfile=<str></code><br> <code>PANTS_SETUPTOOLS_SCM_LOCKFILE</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>&lt;default&gt;</code></span>

<br>

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.14.2rc2/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 `./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.

</div> <br>

<div style="color: purple">

### `console_script`

<code>--setuptools-scm-console-script=<str></code><br> <code>PANTS_SETUPTOOLS_SCM_CONSOLE_SCRIPT</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>None</code></span>

<br>

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.

</div> <br>

<div style="color: purple">

### `entry_point`

<code>--setuptools-scm-entry-point=<str></code><br> <code>PANTS_SETUPTOOLS_SCM_ENTRY_POINT</code><br>

</div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>setuptools&lowbar;scm</code></span>

<br>

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.

</div> <br>

## Deprecated options

None