The utility for publishing Python distributions to PyPi and other Python repositories.
Backend: <span style="color: purple"><code>pants.backend.experimental.python</code></span> Config section: <span style="color: purple"><code>[twine]</code></span>
## Basic options
<div style="color: purple"> <h3><code>skip</code></h3> <code>--[no-]twine-skip</code><br> <code>PANTS_TWINE_SKIP</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>False</code></span>
<br>
Don't use Twine when running `./pants publish`.
</div> <br>
<div style="color: purple"> <h3><code>args</code></h3> <code>--twine-args="[<shell_str>, <shell_str>, ...]"</code><br> <code>PANTS_TWINE_ARGS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>
<br>
Arguments to pass directly to Twine, e.g. `--twine-args='--skip-existing'`.
</div> <br>
## Advanced options
<div style="color: purple"> <h3><code>version</code></h3> <code>--twine-version=<str></code><br> <code>PANTS_TWINE_VERSION</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>twine>=3.7.1,<3.8</code></span>
<br>
Requirement string for the tool.
</div> <br>
<div style="color: purple"> <h3><code>extra_requirements</code></h3> <code>--twine-extra-requirements="['<str>', '<str>', ...]"</code><br> <code>PANTS_TWINE_EXTRA_REQUIREMENTS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "colorama>=0.4.3" ]</pre></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"> <h3><code>interpreter_constraints</code></h3> <code>--twine-interpreter-constraints="['<str>', '<str>', ...]"</code><br> <code>PANTS_TWINE_INTERPRETER_CONSTRAINTS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "CPython>=3.7,<4" ]</pre></span>
<br>
Python interpreter constraints for this tool.
</div> <br>
<div style="color: purple"> <h3><code>lockfile</code></h3> <code>--twine-lockfile=<str></code><br> <code>PANTS_TWINE_LOCKFILE</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code><default></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.12.1/src/python/pants/backend/python/subsystems/twine.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.
To use a custom lockfile, set this option to a file path relative to the build root, then run `./pants generate-lockfiles --resolve=twine`.
As explained at [Third-party dependencies](🔗), lockfile generation via `generate-lockfiles` does not always work and you may want to manually generate the lockfile. You will want to set `[python].invalid_lockfile_behavior = 'ignore'` so that Pants does not complain about missing lockfile headers.
</div> <br>
<div style="color: purple"> <h3><code>console_script</code></h3> <code>--twine-console-script=<str></code><br> <code>PANTS_TWINE_CONSOLE_SCRIPT</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>twine</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"> <h3><code>entry_point</code></h3> <code>--twine-entry-point=<str></code><br> <code>PANTS_TWINE_ENTRY_POINT</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>None</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>
<div style="color: purple"> <h3><code>config</code></h3> <code>--twine-config=<file_option></code><br> <code>PANTS_TWINE_CONFIG</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>None</code></span>
<br>
Path to a .pypirc config file to use. (https://packaging.python.org/specifications/pypirc/)
Setting this option will disable `[twine].config_discovery`. Use this option if the config is located in a non-standard location.
</div> <br>
<div style="color: purple"> <h3><code>config_discovery</code></h3> <code>--[no-]twine-config-discovery</code><br> <code>PANTS_TWINE_CONFIG_DISCOVERY</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>True</code></span>
<br>
If true, Pants will include all relevant config files during runs (`.pypirc`).
Use `[twine].config` instead if your config is in a non-standard location.
</div> <br>
<div style="color: purple"> <h3><code>ca_certs_path</code></h3> <code>--twine-ca-certs-path=<str></code><br> <code>PANTS_TWINE_CA_CERTS_PATH</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code><inherit></code></span>
<br>
Path to a file containing PEM-format CA certificates used for verifying secure connections when publishing python distributions.
Uses the value from `[GLOBAL].ca_certs_path` by default. Set to `"<none>"` to not use the default CA certificate.
</div> <br>
## Deprecated options
None