HomeDocs
DocsCommunityTestimonialsUsersGitHubTwitterBlogJobsTermsPrivacyCookies
TermsPrivacyCookies
Hey! These docs are for version 2.8, which is no longer officially supported. Click here for the latest version, 2.15!


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

See [Building distributions](🔗).

## <code>dependencies</code>

<span style="color: purple">type: <code>Iterable[str] | None</code></span> <span style="color: green">default: <code>None</code></span>

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.

## <code>description</code>

<span style="color: purple">type: <code>str | None</code></span> <span style="color: green">default: <code>None</code></span>

A human-readable description of the target.

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

## <code>entry_points</code>

<span style="color: purple">type: <code>Dict[str, Dict[str, str]] | None</code></span> <span style="color: green">default: <code>None</code></span>

Any entry points, such as `console_scripts` and `gui_scripts`.

Specify as a nested dictionary, with a dictionary for each type of entry point, e.g. `console_scripts` vs. `gui_scripts`. Each dictionary maps the entry point name to either a setuptools entry point ("path.to.module:func") or a Pants target address to a pex_binary target.

Example:



Note that Pants will assume that any value that either starts with `:` or has `/` in it, is a target address to a pex_binary target. Otherwise, it will assume it's a setuptools entry point as defined by https://packaging.python.org/specifications/entry-points/#entry-points-specification. Use `//` as a prefix for target addresses if you need to disambiguate.

Pants will attempt to infer dependencies, which you can confirm by running:



## <code>generate_setup</code>

<span style="color: purple">type: <code>bool | None</code></span> <span style="color: green">default: <code>None</code></span>

Whether to generate setup information for this distribution, based on analyzing sources and dependencies. Set to False to use existing setup information, such as existing setup.py, setup.cfg, pyproject.toml files or similar.

## <code>provides</code>

<span style="color: purple">type: <code>PythonArtifact</code></span> <span style="color: green">required</span>

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 [Custom `setup_py()` kwargs](🔗) for how to write a plugin to dynamically generate kwargs.

## <code>pypi_repositories</code>

<span style="color: purple">type: <code>Iterable[str] | None</code></span> <span style="color: green">default: <code>None</code></span>

List of PyPi repositories to publish the target package to.

## <code>sdist</code>

<span style="color: purple">type: <code>bool</code></span> <span style="color: green">default: <code>True</code></span>

Whether to build an sdist for the distribution.

## <code>sdist_config_settings</code>

<span style="color: purple">type: <code>Dict[str, Iterable[str]] | None</code></span> <span style="color: green">default: <code>None</code></span>

PEP-517 config settings to pass to the build backend when building an sdist.

## <code>skip_twine</code>

<span style="color: purple">type: <code>bool</code></span> <span style="color: green">default: <code>False</code></span>

If true, don't publish this target's packages using Twine.

## <code>tags</code>

<span style="color: purple">type: <code>Iterable[str] | None</code></span> <span style="color: green">default: <code>None</code></span>

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.

## <code>wheel</code>

<span style="color: purple">type: <code>bool</code></span> <span style="color: green">default: <code>True</code></span>

Whether to build a wheel for the distribution.

## <code>wheel_config_settings</code>

<span style="color: purple">type: <code>Dict[str, Iterable[str]] | None</code></span> <span style="color: green">default: <code>None</code></span>

PEP-517 config settings to pass to the build backend when building a wheel.