https://github.com/pypa/build
A simple, correct Python build frontend
https://github.com/pypa/build
python
Last synced: 5 months ago
JSON representation
A simple, correct Python build frontend
- Host: GitHub
- URL: https://github.com/pypa/build
- Owner: pypa
- License: mit
- Created: 2020-05-10T16:20:46.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T20:29:47.000Z (6 months ago)
- Last Synced: 2024-10-29T15:45:36.614Z (6 months ago)
- Topics: python
- Language: Python
- Homepage: https://build.pypa.io
- Size: 854 KB
- Stars: 739
- Watchers: 26
- Forks: 120
- Open Issues: 67
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- jimsghstars - pypa/build - A simple, correct Python build frontend (Python)
README
# build
[](https://results.pre-commit.ci/latest/github/pypa/build/main)
[](https://github.com/pypa/build/actions/workflows/test.yml)
[](https://codecov.io/gh/pypa/build)
[](https://build.pypa.io/en/latest/?badge=latest)
[](https://pypi.org/project/build/)
[](https://discord.gg/pypa)
A simple, correct Python build frontend.
See the [documentation](https://build.pypa.io) for more information.
### Installation
`build` can be installed via `pip` or an equivalent via:
```console
$ pip install build
```
### Usage
```console
$ 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](https://build.pypa.io) for full information.
### Common arguments
- `--sdist` (`-s`): Produce just an SDist
- `--wheel` (`-w`): Produce just a wheel
- `-C=`: 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.
- `--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:
```console
$ 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.
Combining both suggestions yields the following:
```console
$ pipx run build[uv] --installer=uv
```
#### cibuildwheel
If you are using [cibuildwheel][], build is integrated and can be use with either (in your `pyproject.toml`):
```toml
[tool.cibuildwheel]
build-frontend = "build"
```
or
```toml
[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].
[psf code of conduct]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
[pipx]: https://pipx.pypa.io
[uv]: https://docs.astral.sh/uv/
[cibuildwheel]: https://cibuildwheel.pypa.io
[python-build]: https://github.com/conda-forge/python-build-feedstock