Skip to content
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

Open
obestwalter opened this issue Jan 15, 2019 · 1 comment
Open

Explain rationale behind PEP 517/518 improvements #1141

obestwalter opened this issue Jan 15, 2019 · 1 comment
Labels
area:documentation help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted.

Comments

@obestwalter
Copy link
Member

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.

@gaborbernat gaborbernat added the help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted. label May 3, 2019
@gaborbernat gaborbernat added this to the 4.0 milestone Jan 13, 2022
@gaborbernat gaborbernat modified the milestones: 4.0, 4.1 Nov 20, 2022
@gaborbernat gaborbernat removed this from the P-1 milestone Jun 17, 2023
@ljluestc
Copy link

ljluestc commented Sep 5, 2023

If you want to update the package documentation to provide clearer information about why isolated_build requires a pyproject.toml file, you can add a section like this:

## 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 isolated_build along with a properly configured pyproject.toml, you ensure a consistent and isolated build process for your package.


Feel free to adjust the content to match your project's documentation style and structure. This addition should provide clearer information to users about the purpose and benefits of using `isolated_build` with a `pyproject.toml` file.

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.
Projects
None yet
Development

No branches or pull requests

3 participants