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

Clarify that pyproject.toml config will not be removed #3295

Merged
merged 1 commit into from
May 16, 2022

Conversation

garrison
Copy link
Contributor

Summary of changes

The current documentation regarding pyproject.toml claims that support for using it to specify package metadata and build configuration options might be "completely removed" in a future setuptools release.

However, nowadays it is clear (#1688 (comment) and #3214) that pyproject.toml is not going to be removed, and is in fact intended to be the preferred format at some point in the future.

This makes an incremental change toward that future by clarifying that pyproject.toml support will not be removed in a future release of setuptools.

Pull Request Checklist

The current documentation regarding `pyproject.toml` claims that
support for using it to specify package metadata and build
configuration options might be "completely removed" in a future
release.

However, nowadays it is clear
(pypa#1688 (comment)
and pypa#3214) that `pyproject.toml` is not going anywhere, is here
to stay, and is in fact expected to be the preferred format
in the future.

This makes an incremental change toward that future by clarifying
that `pyproject.toml` support will not be removed in a future
release of setuptools.
@abravalheri
Copy link
Contributor

Thank you very much @garrison.

I am completely fine with this change, and I do think there is no risk of removing support for (at least) the [project] table in pyproject.toml (unless there is a new and revolutionary PEP). The [tool.setuptools] table is still very likely to change and should not be taken as stable, but that behaviour seems to be covered by the rest of the text.

Since I am very biased 😅, I think we can leave this PR open for a little while just to see if another maintainer or member of the community has an objection.

@abravalheri abravalheri merged commit 7f2c11b into pypa:main May 16, 2022
@garrison garrison deleted the pyproject-is-here-to-stay branch May 17, 2022 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants