| Name | build JSON |
| Version |
1.2.2.post1
JSON |
| download |
| home_page | None |
| Summary | A simple, correct Python build frontend |
| upload_time | 2024-10-06 17:22:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| 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.
### 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.
- `--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
Raw data
{
"_id": null,
"home_page": null,
"name": "build",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"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/7d/46/aeab111f8e06793e4f0e421fcad593d547fb8313b50990f31681ee2fb1ad/build-1.2.2.post1.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/`.\nSee the [documentation](https://build.pypa.io) for full information.\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- `--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 use\n`--installer=uv`. You can get a Python wheel for `uv` with the `[uv]` extra.\nCombining both suggestions yields the following:\n\n```console\n$ pipx run build[uv] --installer=uv\n```\n\n#### cibuildwheel\n\nIf you are using [cibuildwheel][], build is integrated and can be use with either (in your `pyproject.toml`):\n\n```toml\n[tool.cibuildwheel]\nbuild-frontend = \"build\"\n```\n\nor\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.2.2.post1",
"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": "",
"digests": {
"blake2b_256": "84c280633736cd183ee4a62107413def345f7e6e3c01563dbca1417363cf957e",
"md5": "5cd086437c1771883c365758c089c820",
"sha256": "1d61c0887fa860c01971625baae8bdd338e517b836a2f70dd1f7aa3a6b2fc5b5"
},
"downloads": -1,
"filename": "build-1.2.2.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5cd086437c1771883c365758c089c820",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22950,
"upload_time": "2024-10-06T17:22:23",
"upload_time_iso_8601": "2024-10-06T17:22:23.299090Z",
"url": "https://files.pythonhosted.org/packages/84/c2/80633736cd183ee4a62107413def345f7e6e3c01563dbca1417363cf957e/build-1.2.2.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7d46aeab111f8e06793e4f0e421fcad593d547fb8313b50990f31681ee2fb1ad",
"md5": "5492ba887b363f483d64a11bbec0c34a",
"sha256": "b36993e92ca9375a219c99e606a122ff365a760a2d4bba0caa09bd5278b608b7"
},
"downloads": -1,
"filename": "build-1.2.2.post1.tar.gz",
"has_sig": false,
"md5_digest": "5492ba887b363f483d64a11bbec0c34a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 46701,
"upload_time": "2024-10-06T17:22:25",
"upload_time_iso_8601": "2024-10-06T17:22:25.251330Z",
"url": "https://files.pythonhosted.org/packages/7d/46/aeab111f8e06793e4f0e421fcad593d547fb8313b50990f31681ee2fb1ad/build-1.2.2.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-06 17:22:25",
"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"
}
