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

apply PEP621 #388

Merged
merged 11 commits into from
Nov 7, 2024
Merged

apply PEP621 #388

merged 11 commits into from
Nov 7, 2024

Conversation

zacharyburnett
Copy link
Contributor

@zacharyburnett zacharyburnett commented Nov 4, 2024

PEP621 (https://peps.python.org/pep-0621/) defines using the pyproject.toml file to store project metadata in the [project] table. This has several advantages over using setup.cfg or setup.py to store the project metadata, namely:

  • consolidates metadata and configuration into one file; pyproject.toml is required by PEP517 (https://peps.python.org/pep-0517/) and many third party tools use it to store their configuration
  • allows alternate build tools other than setuptools (such as hatch or meson) to read the same project metadata

Copy link

google-cla bot commented Nov 4, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
Copy link
Member

@jmr jmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you give a bit more info than just "apply PEP 621"? I don't know anything about Python packaging, so a few sentences of explanation would be helpful.

https://google.github.io/eng-practices/review/developer/cl-descriptions.html#informative

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@jmr
Copy link
Member

jmr commented Nov 4, 2024

@selimnairb This is moving the setup.cfg you added in #313 to pyproject.toml. Do you want to take a look?

@selimnairb
Copy link
Contributor

@selimnairb This is moving the setup.cfg you added in #313 to pyproject.toml. Do you want to take a look?

@jmr Yes, I'll pull it down today and have a look.

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
CONTRIBUTORS Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
Co-authored-by: Zach Burnett <zachary.r.burnett@gmail.com>
@jmr jmr merged commit 0fb1b8a into google:master Nov 7, 2024
1 check passed
@jmr
Copy link
Member

jmr commented Nov 7, 2024

Thanks!

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.

3 participants