Skip to content

build

pyproject-build documentation

Build

Bases: Tool[_R]

Methods:

Name Description
__call__

A simple, correct Python build frontend.

Attributes:

Name Type Description
argv Build[Argv]

argv property

argv: Build[Argv]

__call__

__call__(*args: str | PathLike[str], config_json: Value = ..., config_setting: Value = ..., dependency_constraints_txt: Value = ..., env_dir: Value = ..., installer: Value = ..., metadata: Flag = ..., no_isolation: Flag = ..., outdir: Value = ..., quiet: Flag = ..., report: Value = ..., sdist: Flag = ..., sdist_extract_dir: Value = ..., skip_dependency_check: Flag = ..., verbose: Flag = ..., wheel: Flag = ..., **flags: Any) -> _R

A simple, correct Python build frontend.

Parameters:

Name Type Description Default
config_json Value

settings to pass to the backend as a JSON object. Added in 1.3.0.

...
config_setting Value

settings to pass to the backend.

...
dependency_constraints_txt Value

constrain build dependencies using a constraints.txt when installing dependencies. Added in 1.4.1.

...
env_dir Value

create the isolated build environment at this location instead of a temporary directory. Added in 1.5.1.

...
installer Value

Python package installer to use (defaults to pip).

...
metadata Flag

print out a wheel's metadata in JSON format, building it first unless the source argument is already a .whl. Added in 1.4.0.

...
no_isolation Flag

disable building the project in an isolated virtual environment.

...
outdir Value

output directory (defaults to {srcdir}\dist).

...
quiet Flag

reduce verbosity. Added in 1.4.0.

...
report Value

write a machine-readable JSON report of the built artifacts (name, path, kind, size and SHA-256 hash) to this path. Added in 1.5.1.

...
sdist Flag

build a source distribution (disables the default behavior).

...
sdist_extract_dir Value

extract the intermediate sdist to PATH (created if missing and kept afterwards) instead of a random temporary directory; reusing it across rebuilds gives compiler caches such as ccache/sccache a stable source path. Added in 1.5.1.

...
skip_dependency_check Flag

do not check that build dependencies are installed.

...
verbose Flag

increase verbosity.

...
wheel Flag

build a wheel (disables the default behavior).

...