-
-
Notifications
You must be signed in to change notification settings - Fork 509
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Explain rationale behind PEP 517/518 improvements #1141
Labels
area:documentation
help:wanted
Issues that have been acknowledged, a solution determined and a PR might likely be accepted.
Comments
If you want to update the package documentation to provide clearer information about why ## Using `isolated_build` with `pyproject.toml`
When using the `isolated_build` option in your `pyproject.toml` file, it allows your package to be built in an isolated environment using the PEP 517 build backend. This isolation ensures that your package's build dependencies are separate from your development environment, reducing the chance of conflicting dependencies.
To enable `isolated_build`, you need to have a valid `pyproject.toml` file in your project directory. The `pyproject.toml` file should define the necessary build backend configuration and dependencies for building your package.
Here's an example `pyproject.toml` configuration that utilizes `isolated_build`:
```toml
[build-system]
requires = ["setuptools >= 40.8.0", "wheel"]
build-backend = "setuptools.build_meta"
isolated_build = true
[tool.poetry.dependencies]
python = "^3.6" By using
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area:documentation
help:wanted
Issues that have been acknowledged, a solution determined and a PR might likely be accepted.
In #1137 it got clear that it might be a good idea to extend the package docs a bit to explain why
isolated_build
needs a pyproject.toml. We could have done that more implicitly, but that would have been dirty and hidden away what it's all about to the packager, so I agree with the intention of @gaborbernat - we just need to explain it a bit clearer.The text was updated successfully, but these errors were encountered: