whey.foreman

The foreman is responsible for loading the configuration calling the builders.

Classes:

Foreman(project_dir)

Responsible for loading the configuration calling the builders.

class Foreman(project_dir)

Bases: object

Responsible for loading the configuration calling the builders.

Methods:

build_binary([build_dir, out_dir, verbose, …])	Build a binary distribution using the binary builder configured in pyproject.toml.
build_sdist([build_dir, out_dir, verbose, …])	Build a sdist distribution using the sdist builder configured in pyproject.toml.
build_wheel([build_dir, out_dir, verbose, …])	Build a wheel distribution using the wheel builder configured in pyproject.toml.
get_builder(distribution_type)	Returns the builder for the given distribution type.

Attributes:

config	Configuration parsed from pyproject.toml.
project_dir	The pyproject.toml directory

build_binary(build_dir=None, out_dir=None, *args, verbose=False, colour=None, **kwargs)

Build a binary distribution using the binary builder configured in pyproject.toml.

Return type

str

Returns

The filename of the created archive.

build_sdist(build_dir=None, out_dir=None, *args, verbose=False, colour=None, **kwargs)

Build a sdist distribution using the sdist builder configured in pyproject.toml.

Return type

str

Returns

The filename of the created archive.

build_wheel(build_dir=None, out_dir=None, *args, verbose=False, colour=None, **kwargs)

Build a wheel distribution using the wheel builder configured in pyproject.toml.

Return type

str

Returns

The filename of the created archive.

config

Configuration parsed from pyproject.toml.

get_builder(distribution_type)

Returns the builder for the given distribution type.

Parameters

distribution_type (str) – The distribution type, such as 'source' or 'wheel'.

Return type

Type[AbstractBuilder]

project_dir

Type:    PathPlus

The pyproject.toml directory