| Name | build JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | A simple, correct Python build frontend |
| upload_time | 2025-08-01 21:27:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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. 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:
```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. For example, using pipx like above:
```console
$ pipx run 'build[uv]' --installer uv
```
If you already have uv, you don't need the extra. For example:
```console
$ 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:
```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
Raw data
{
"_id": null,
"home_page": null,
"name": "build",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Filipe La\u00edns <lains@riseup.net>, Bern\u00e1t G\u00e1bor <gaborjbernat@gmail.com>, layday <layday@protonmail.com>, Henry Schreiner <henryschreineriii@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/25/1c/23e33405a7c9eac261dff640926b8b5adaed6a6eb3e1767d441ed611d0c0/build-1.3.0.tar.gz",
"platform": null,
"description": "# build\n\n[](https://results.pre-commit.ci/latest/github/pypa/build/main)\n[](https://github.com/pypa/build/actions/workflows/test.yml)\n[](https://codecov.io/gh/pypa/build)\n\n[](https://build.pypa.io/en/latest/?badge=latest)\n[](https://pypi.org/project/build/)\n[](https://discord.gg/pypa)\n\nA simple, correct Python build frontend.\n\nSee the [documentation](https://build.pypa.io) for more information.\n\n### Installation\n\n`build` can be installed via `pip` or an equivalent via:\n\n```console\n$ pip install build\n```\n\n### Usage\n\n```console\n$ python -m build\n```\n\nThis will build the package in an isolated environment, generating a\nsource-distribution and wheel in the directory `dist/`. See the\n[documentation](https://build.pypa.io) for full information. Build is also\navailable via the command line as `pyproject-build` once installed.\n\n### Common arguments\n\n- `--sdist` (`-s`): Produce just an SDist\n- `--wheel` (`-w`): Produce just a wheel\n- `-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.\n- `--config-json=<value>`: An alternative way to pass in complex config settings as JSON strings. Can't be used with `-C`.\n- `--installer`: Pick an installer for the isolated build (`pip` or `uv`).\n- `--no-isolation` (`-n`): Disable build isolation.\n- `--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.\n- `--outdir` (`-o`): The output directory (defaults to `dist`)\n\nSome common combinations of arguments:\n\n- `--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.\n- `-nx`: Disable build isolation and dependency checking. Identical to pip and uv's `--no-build-isolation` flag.\n\n### Integration with other tools\n\n#### pipx\n\nIf you use [pipx][], such as in GitHub Actions, the following command will download\nand run build in one step:\n\n```console\n$ pipx run build\n```\n\n#### uv\n\nIf you want to use [uv][] to speed up the virtual environment creation, you can\nuse `--installer=uv`. You can get a Python wheel for `uv` with the `[uv]`\nextra. For example, using pipx like above:\n\n```console\n$ pipx run 'build[uv]' --installer uv\n```\n\nIf you already have uv, you don't need the extra. For example:\n\n```console\n$ uvx --from build pyproject-build --installer uv\n```\n\n#### cibuildwheel\n\nIf 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:\n\n```toml\n[tool.cibuildwheel]\nbuild-frontend = \"build[uv]\"\n```\n\n(Be sure to pre-install uv before running cibuildwheel for this one!)\n\n#### Conda-forge\n\nOn conda-forge, this package is called [python-build][].\n\n### Code of Conduct\n\nEveryone interacting in the build's codebase, issue trackers, chat rooms, and mailing lists is expected to follow\nthe [PSF Code of Conduct].\n\n[psf code of conduct]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md\n[pipx]: https://pipx.pypa.io\n[uv]: https://docs.astral.sh/uv/\n[cibuildwheel]: https://cibuildwheel.pypa.io\n[python-build]: https://github.com/conda-forge/python-build-feedstock\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple, correct Python build frontend",
"version": "1.3.0",
"project_urls": {
"changelog": "https://build.pypa.io/en/stable/changelog.html",
"homepage": "https://build.pypa.io",
"issues": "https://github.com/pypa/build/issues",
"source": "https://github.com/pypa/build"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cb8c2b30c12155ad8de0cf641d76a8b396a16d2c36bc6d50b621a62b7c4567c1",
"md5": "1f30d82d2e3fcabaac5b46e1d1260704",
"sha256": "7145f0b5061ba90a1500d60bd1b13ca0a8a4cebdd0cc16ed8adf1c0e739f43b4"
},
"downloads": -1,
"filename": "build-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f30d82d2e3fcabaac5b46e1d1260704",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 23382,
"upload_time": "2025-08-01T21:27:07",
"upload_time_iso_8601": "2025-08-01T21:27:07.844276Z",
"url": "https://files.pythonhosted.org/packages/cb/8c/2b30c12155ad8de0cf641d76a8b396a16d2c36bc6d50b621a62b7c4567c1/build-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "251c23e33405a7c9eac261dff640926b8b5adaed6a6eb3e1767d441ed611d0c0",
"md5": "48f7fbc11051430eab3c1abe216bed7a",
"sha256": "698edd0ea270bde950f53aed21f3a0135672206f3911e0176261a31e0e07b397"
},
"downloads": -1,
"filename": "build-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "48f7fbc11051430eab3c1abe216bed7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 48544,
"upload_time": "2025-08-01T21:27:09",
"upload_time_iso_8601": "2025-08-01T21:27:09.268607Z",
"url": "https://files.pythonhosted.org/packages/25/1c/23e33405a7c9eac261dff640926b8b5adaed6a6eb3e1767d441ed611d0c0/build-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-01 21:27:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pypa",
"github_project": "build",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "build"
}
