Configuration

whey-pth is configured in the pyproject.toml file defined in PEP 517 and PEP 518.

See also

The whey documentation contains instructions for configuring whey itself.

To enable whey-pth, add the following lines to your pyprojet.toml file:

[tool.whey.builders]
wheel = "whey_pth_wheel"

The whey-pth-specific configuration is defined in the tool.whey-pth table.

[tool.whey-pth]

As a minimum, this table should contain the keys name and pth-content.

name

Type: String

The filename of the .pth file, relative to the root of the distribution archive. If the filename does not end with .pth the extension will be appended automatically.

Example:

[tool.whey-pth]
name = "virtualenv.pth"

pth-content

Type: String

The content of the .pth file. See https://docs.python.org/3/library/site.html for details on the expected contents of the file.

Example:

[tool.whey-pth]
pth-content = "import _virtualenv"

additional-wheel-files

Type: Array of strings

A list of MANIFEST.in-style entries for additional files to include in the wheel.

The supported commands are:

Command	Description
include pat1 pat2 ...	Add all files matching any of the listed patterns
exclude pat1 pat2 ...	Remove all files matching any of the listed patterns
recursive-include dir-pattern pat1 pat2 ...	Add all files under directories matching dir-pattern that match any of the listed patterns
recursive-exclude dir-pattern pat1 pat2 ...	Remove all files under directories matching dir-pattern that match any of the listed patterns