Pants v2: The ergonomic build system

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable, user-friendly build system for growing codebases. It's currently focused on Python, with support for other languages coming soon.

Here you'll find guides to help you get started with Pants v2, comprehensive documentation on how to configure, run and customize Pants v2, and information on how to get help from the Pants community.

Get Started

setuptools

The Python setuptools library (https://github.com/pypa/setuptools).

Config section: [setuptools]

Basic options

None

Advanced options

version

--setuptools-version=<str>
PANTS_SETUPTOOLS_VERSION
default: setuptools>=50.3.0,<54.0

Requirement string for the tool.


extra_requirements

--setuptools-extra-requirements="['<str>', '<str>', ...]"
PANTS_SETUPTOOLS_EXTRA_REQUIREMENTS
default:
[
  "wheel>=0.35.1,<0.37"
]

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.


Deprecated options

entry_point

--setuptools-entry-point=<str>
PANTS_SETUPTOOLS_ENTRY_POINT
default: None

Deprecated, will be removed in version: 2.5.0.dev0.
This option was never used.

DEPRECATED: Unused.


interpreter_constraints

--setuptools-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_SETUPTOOLS_INTERPRETER_CONSTRAINTS
default: []

Deprecated, will be removed in version: 2.5.0.dev0.
Interpreter constraints for setup.py execution are now derived from the `python_distribution` being packaged so this option is not needed.

DEPRECATED: Python interpreter constraints to use when selecting an interpreter to package `python_distribution` targets using setup.py.


Updated about a month ago


setuptools


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.