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

PEP 621: Migrate from setup.py to pyproject.toml #790

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cclauss
Copy link
Contributor

@cclauss cclauss commented Nov 11, 2024

https://setuptools.pypa.io/en/latest/userguide/quickstart.html#setuppy-discouraged

https://setuptools.pypa.io/en/latest/userguide/quickstart.html

We recommend users expose as much as possible configuration in a more declarative way via the pyproject.toml or setup.cfg, and keep the setup.py minimal with only the dynamic parts (or even omit it completely if applicable).

From validate-pyproject README:

With the approval of PEP 517 and PEP 518, the Python community shifted towards a strong focus on standardization for packaging software, which allows more freedom when choosing tools during development and make sure packages created using different technologies can interoperate without the need for custom installation procedures.

This shift became even more clear when PEP 621 was also approved, as a standardized way of specifying project metadata and dependencies.

validate-pyproject was born in this context, with the mission of validating pyproject.toml files, and making sure they are compliant with the standards and PEPs.

https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#writing-pyproject-toml

git checkout -b setup.py-to-pyproject.toml
pipx run setuptools-py2cfg setup.py >> setup.cfg
pipx run 'ini2toml[full]' setup.cfg -o pyproject.toml
git add pyproject.toml
pipx run pyproject-fmt pyproject.toml
pipx run 'validate-pyproject[all]' pyproject.toml
git rm setup.py
git rm setup.cfg
git commit -am"PEP 621: Migrate from setup.py to pyproject.toml"
git push

@ftnext Your review, please.

@cclauss cclauss marked this pull request as draft November 11, 2024 16:32
@cclauss cclauss force-pushed the setup.py-to-pyproject.toml branch from 57a1e5f to b27c4b6 Compare December 10, 2024 09:57
@cclauss cclauss force-pushed the setup.py-to-pyproject.toml branch from b27c4b6 to 1b5e7b7 Compare December 10, 2024 10:11
@cclauss cclauss marked this pull request as ready for review December 10, 2024 10:24
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.

1 participant