pypa / pypa/packaging.python.org
Contradictions/Inconsistencies between packaging tutorial and guide
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
Page 1: Packaging Python Projects
Page 2: Packaging and distributing projects
The first states
"setup.py # optional, needed to make editable pip installs work"
The second states
"The most important file is setup.py which exists at the root of your project directory."
The first mentions pyproject.toml, whereas the second doesn't mention it at all.
I know that one's a "tutorial" and the other is a "guide", and the website states that guides have more detailed information. In this case it appears there's some detail in the tutorial that isn't in the guide.
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 by comparing the linked Packaging Python Projects tutorial and Packaging and distributing projects guide, focusing on their statements about setup.py and pyproject.toml. Check the surrounding packaging guidance before deciding how the pages should align. Done means the two pages consistently explain these files without contradictory guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100