Skip to main content
Version: 2.12 (deprecated)

setuptools

Python setuptools, used to package python_distribution targets.

Backend: pants.backend.python

Config section: [setuptools]

Basic options​

None

Advanced options​

extra_requirements​

--setuptools-extra-requirements="['<str>', '<str>', ...]"
PANTS_SETUPTOOLS_EXTRA_REQUIREMENTS
pants.toml
[setuptools]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "wheel>=0.35.1,<0.38"
]

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.

lockfile​

--setuptools-lockfile=<str>
PANTS_SETUPTOOLS_LOCKFILE
pants.toml
[setuptools]
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.12.1/src/python/pants/backend/python/subsystems/setuptools.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 /home/josh/work/scie-pants/dist/pants generate-lockfiles --resolve=setuptools.

As explained at https://www.pantsbuild.org/v2.12/docs/python-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.

version​

--setuptools-version=<str>
PANTS_SETUPTOOLS_VERSION
pants.toml
[setuptools]
version = <str>
default: setuptools>=63.1.0,<64.0

Requirement string for the tool.

Deprecated options​

None

None