Skip to main content
Version: 2.6 (deprecated)

python_distribution


A publishable Python setuptools distribution (e.g. an sdist or wheel).

See https://www.pantsbuild.org/v2.6/docs/python-distributions.

Backend: ``


provides

PythonArtifact
required

The setup.py kwargs for the external artifact built from this target.

You must define name. You can also set almost any keyword argument accepted by setup.py in the setup() function: (https://packaging.python.org/guides/distributing-packages-using-setuptools/#setup-args).

See https://www.pantsbuild.org/v2.6/docs/plugins-setup-py for how to write a plugin to dynamically generate kwargs.

dependencies

Iterable[str] | None
default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib'].

Alternatively, you may include file names. Pants will find which target owns that file, and create a new target from that which only includes the file in its sources field. For files relative to the current BUILD file, prefix with ./; otherwise, put the full path, e.g. ['./sibling.txt', 'resources/demo.json'].

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description

str | None
default: None

A human-readable description of the target.

Use ./pants list --documented :: to see all targets with descriptions.

setup_py_commands

Iterable[str] | None
default: None

The runtime commands to invoke setup.py with to create the distribution, e.g. ["bdist_wheel", "--python-tag=py36.py37", "sdist"].

If empty or unspecified, will just create a chroot with a setup() function.

tags

Iterable[str] | None
default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run ./pants --tag='integration_test' test :: to only run on targets with that tag.