twine

skip

--[no-]twine-skip

PANTS_TWINE_SKIP

If true, don't use Twine when running pants publish.

args

--twine-args="[<shell_str>, <shell_str>, ...]"

PANTS_TWINE_ARGS

Arguments to pass directly to Twine, e.g. --twine-args='--skip-existing'.

version

--twine-version=<str>

PANTS_TWINE_VERSION

Requirement string for the tool.

extra_requirements

--twine-extra-requirements="['<str>', '<str>', ...]"

PANTS_TWINE_EXTRA_REQUIREMENTS

[
  "colorama>=0.4.3"
]

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

--twine-interpreter-constraints="['<str>', '<str>', ...]"

PANTS_TWINE_INTERPRETER_CONSTRAINTS

[
  "CPython>=3.7,<4"
]

Python interpreter constraints for this tool.

lockfile

--twine-lockfile=<str>

PANTS_TWINE_LOCKFILE

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.1rc2/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 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=twine.

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.

console_script

--twine-console-script=<str>

PANTS_TWINE_CONSOLE_SCRIPT

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

--twine-entry-point=<str>

PANTS_TWINE_ENTRY_POINT

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.

config

--twine-config=<file_option>

PANTS_TWINE_CONFIG

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.

config_discovery

--[no-]twine-config-discovery

PANTS_TWINE_CONFIG_DISCOVERY

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.

ca_certs_path

--twine-ca-certs-path=<str>

PANTS_TWINE_CA_CERTS_PATH

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 any certificates.

Even when using the docker_environment and remote_environment targets, this path will be read from the local host, and those certs will be used in the environment.

This option cannot be overridden via environment targets, so if you need a different value than what the rest of your organization is using, override the value via an environment variable, CLI argument, or .pants.rc file. See Options.