Hey! These docs are for version 2.10, which is no longer officially supported. Click here for the latest version, 2.14!

The utility for publishing Python distributions to PyPi and other Python repositories.

Backend: pants.backend.experimental.python
Config section: [twine]

Basic options

skip

--[no-]twine-skip
PANTS_TWINE_SKIP
default: False

Don't use Twine when running ./pants publish.


args

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

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


Advanced options

version

--twine-version=<str>
PANTS_TWINE_VERSION
default: twine>=3.7.1,<3.8

Requirement string for the tool.


extra_requirements

--twine-extra-requirements="['<str>', '<str>', ...]"
PANTS_TWINE_EXTRA_REQUIREMENTS
default:
[
  "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
default:
[
  "CPython>=3.6"
]

Python interpreter constraints for this tool.


lockfile

--twine-lockfile=<str>
PANTS_TWINE_LOCKFILE
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.10.1rc1/src/python/pants/backend/python/subsystems/twine_lockfile.txt 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.

Lockfile generation currently does not wire up the [python-repos] options. If lockfile generation fails, you can manually generate a lockfile, such as by using pip-compile or pip freeze. Set this option to the path to your manually generated lockfile. When manually maintaining lockfiles, set [python].invalid_lockfile_behavior = 'ignore'.


console_script

--twine-console-script=<str>
PANTS_TWINE_CONSOLE_SCRIPT
default: twine

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
default: None

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
default: None

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
default: True

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
default: <inherit>

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.


Deprecated options

None