Repository navigation
Use pyproject.toml for PyPI README metadata - #2146
harshitethic wants to merge 2 commits into
Conversation
|
Thanks for the update. Could you explain why using pyproject.toml is preferred in this case instead of the previous approach? |
|
|
||
| You can check your README for markup errors before uploading as follows: | ||
|
|
||
| 1. Install the latest version of `twine <https://github.com/pypa/twine>`_; |
There was a problem hiding this comment.
This change doesn't seem to be related to the declared goal of the PR
There was a problem hiding this comment.
Thanks for catching the unrelated Twine wording change. I restored the original version guidance in commit 710e30f, so the PR stays focused on modernizing README metadata examples to [project].readme. Focused local text checks and git diff --check passed; hosted documentation checks are still running.
|
Good question. The reason is standardization of the metadata declaration, not that |
|
https://dontquotetheai.com would be nice, though, as it's noisy. |
Addresses #971.
Summary
setup.pyREADME metadata guidance with[project].readmeinpyproject.tomltwine checkvalidationValidation
📚 Documentation preview 📚: https://python-packaging-user-guide--2146.org.readthedocs.build/en/2146/