twine
The utility for publishing Python distributions to PyPI and other Python repositories.
This version of Pants uses twine
version 4.0.2 by default. Use a dedicated lockfile and the install_from_resolve
option to control this.
Backend: pants.backend.experimental.python
Config section: [twine]
Basic options
args
--twine-args="[<shell_str>, <shell_str>, ...]"
PANTS_TWINE_ARGS
[twine]
args = [
<shell_str>,
<shell_str>,
...,
]
[]
Arguments to pass directly to Twine, e.g. --twine-args='--skip-existing'
.
skip
--[no-]twine-skip
PANTS_TWINE_SKIP
[twine]
skip = <bool>
False
If true, don't use Twine when running pants publish
.
Advanced options
ca_certs_path
--twine-ca-certs-path=<str>
PANTS_TWINE_CA_CERTS_PATH
[twine]
ca_certs_path = <str>
<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 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 https://www.pantsbuild.org/2.24/docs/using-pants/key-concepts/options.
config
--twine-config=<file_option>
PANTS_TWINE_CONFIG
[twine]
config = <file_option>
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
[twine]
config_discovery = <bool>
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
[twine]
console_script = <str>
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
[twine]
entry_point = <str>
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.
install_from_resolve
--twine-install-from-resolve=<str>
PANTS_TWINE_INSTALL_FROM_RESOLVE
[twine]
install_from_resolve = <str>
None
If specified, install the tool using the lockfile for this named resolve.
This resolve must be defined in [python].resolves
, as described in https://www.pantsbuild.org/2.24/docs/python/overview/lockfiles#lockfiles-for-tools.
The resolve's entire lockfile will be installed, unless specific requirements are listed via the requirements
option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.
If unspecified, and the lockfile
option is unset, the tool will be installed using the default lockfile shipped with Pants, which uses twine
version 4.0.2.
If unspecified, and the lockfile
option is set, the tool will use the custom twine
"tool lockfile" generated from the version
and extra_requirements
options. But note that this mechanism is deprecated.
interpreter_constraints
--twine-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_TWINE_INTERPRETER_CONSTRAINTS
[twine]
interpreter_constraints = [
'<str>',
'<str>',
...,
]
[ "CPython>=3.8,<4" ]
Python interpreter constraints for this tool.
requirements
--twine-requirements="['<str>', '<str>', ...]"
PANTS_TWINE_REQUIREMENTS
[twine]
requirements = [
'<str>',
'<str>',
...,
]
[]
If install_from_resolve
is specified, install these requirements, at the versions provided by the specified resolve's lockfile.
Values can be pip-style requirements (e.g., tool
or tool==1.2.3
or tool>=1.2.3
), or addresses of python_requirement
targets (or targets that generate or depend on python_requirement
targets). Make sure to use the //
prefix to refer to targets using their full address from the root (e.g. //3rdparty/python:tool
). This is necessary to distinguish address specs from local or VCS requirements.
The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.
If unspecified, install the entire lockfile.
Deprecated options
None
Related subsystems
None