pypa / pypa/packaging.python.org
Update PyPI README instructions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
While reviewing https://github.com/pypa/packaging.python.org/pull/969, I noticed that making-a-pypi-friendly-readme.rst uses setup.py, while packaging-projects.rst recommends setup.cfg.
I think the README guide should be updated to use setup.cfg. I think it'd also be nice to link to making-a-pypi-friendly-readme from other relevant guides, such as packaging-projects and distributing-packages-using-setuptools.
Somewhat related: https://github.com/pypa/packaging.python.org/issues/887
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with source/guides/making-a-pypi-friendly-readme.rst and compare its setup.py instructions with source/tutorials/packaging-projects.rst. Review the README sections in packaging-projects.rst and distributing-packages-using-setuptools.rst for relevant links. Done means the guide uses setup.cfg and the appropriate guides link to making-a-pypi-friendly-readme.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100