Skip to main content

A simple, correct Python build frontend

Project description

build

pre-commit.ci status CI test codecov

Documentation Status PyPI version Discord

A simple, correct Python build frontend.

See the documentation for more information.

Installation

build can be installed via pip or an equivalent via:

$ pip install build

Usage

$ python -m build

This will build the package in an isolated environment, generating a source-distribution and wheel in the directory dist/. See the documentation for full information. Build is also available via the command line as pyproject-build once installed.

Common arguments

  • --sdist (-s): Produce just an SDist
  • --wheel (-w): Produce just a wheel
  • -C<option>=<value>: A Config-setting, the PEP 517 way of passing options to a backend. Can be passed multiple times. Matching options will make a list. Note that setuptools has very limited support.
  • --config-json=<value>: An alternative way to pass in complex config settings as JSON strings. Can't be used with -C.
  • --installer: Pick an installer for the isolated build (pip or uv).
  • --no-isolation (-n): Disable build isolation.
  • --skip-dependency-check (-x): Disable dependency checking when not isolated; this should be done if some requirements or version ranges are not required for non-isolated builds.
  • --outdir (-o): The output directory (defaults to dist)

Some common combinations of arguments:

  • --sdist --wheel (-sw): Produce and SDist and a wheel, both from the source distribution. The default (if no flag is passed) is to build an SDist and then build a wheel from the SDist.
  • -nx: Disable build isolation and dependency checking. Identical to pip and uv's --no-build-isolation flag.

Integration with other tools

pipx

If you use pipx, such as in GitHub Actions, the following command will download and run build in one step:

$ pipx run build

uv

If you want to use uv to speed up the virtual environment creation, you can use --installer=uv. You can get a Python wheel for uv with the [uv] extra. For example, using pipx like above:

$ pipx run 'build[uv]' --installer uv

If you already have uv, you don't need the extra. For example:

$ uvx --from build pyproject-build --installer uv

cibuildwheel

If you are using cibuildwheel, build is integrated and the default builder in 3.0+. If you want to use uv as the installer, you can use:

[tool.cibuildwheel]
build-frontend = "build[uv]"

(Be sure to pre-install uv before running cibuildwheel for this one!)

Conda-forge

On conda-forge, this package is called python-build.

Code of Conduct

Everyone interacting in the build's codebase, issue trackers, chat rooms, and mailing lists is expected to follow the PSF Code of Conduct.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

build-1.3.0.tar.gz (48.5 kB view details)

Uploaded Source

Built Distribution

build-1.3.0-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file build-1.3.0.tar.gz.

File metadata

  • Download URL: build-1.3.0.tar.gz
  • Upload date:
  • Size: 48.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for build-1.3.0.tar.gz
Algorithm Hash digest
SHA256 698edd0ea270bde950f53aed21f3a0135672206f3911e0176261a31e0e07b397
MD5 48f7fbc11051430eab3c1abe216bed7a
BLAKE2b-256 251c23e33405a7c9eac261dff640926b8b5adaed6a6eb3e1767d441ed611d0c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for build-1.3.0.tar.gz:

Publisher: cd.yml on pypa/build

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file build-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: build-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for build-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7145f0b5061ba90a1500d60bd1b13ca0a8a4cebdd0cc16ed8adf1c0e739f43b4
MD5 1f30d82d2e3fcabaac5b46e1d1260704
BLAKE2b-256 cb8c2b30c12155ad8de0cf641d76a8b396a16d2c36bc6d50b621a62b7c4567c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for build-1.3.0-py3-none-any.whl:

Publisher: cd.yml on pypa/build

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page