Skip to main content
Version: 2.9 (deprecated)

twine

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

Backend: ``

Config section: [twine]

Basic options​

args​

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

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

skip​

--[no-]twine-skip
PANTS_TWINE_SKIP
pants.toml
[twine]
skip = <bool>
default: False

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

Advanced options​

ca_certs_path​

--twine-ca-certs-path=<str>
PANTS_TWINE_CA_CERTS_PATH
pants.toml
[twine]
ca_certs_path = <str>
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.

config​

--twine-config=<file_option>
PANTS_TWINE_CONFIG
pants.toml
[twine]
config = <file_option>
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
pants.toml
[twine]
config_discovery = <bool>
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.

console_script​

--twine-console-script=<str>
PANTS_TWINE_CONSOLE_SCRIPT
pants.toml
[twine]
console_script = <str>
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
pants.toml
[twine]
entry_point = <str>
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.

extra_requirements​

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

Python interpreter constraints for this tool.

lockfile​

--twine-lockfile=<str>
PANTS_TWINE_LOCKFILE
pants.toml
[twine]
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.9.2/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'.

version​

--twine-version=<str>
PANTS_TWINE_VERSION
pants.toml
[twine]
version = <str>
default: twine==3.6.0

Requirement string for the tool.

Deprecated options​

None

None