pypa / pypa/packaging.python.org
Explain clearly that python / pip / other commands are not Python code
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
https://github.com/pypa/packaging-problems/issues/369 is the latest instance of a person trying to type python setup.py sdist or pip install something in the Python shell rather than in a system console, which is not obvious to everyone.
None of https://packaging.python.org/tutorials/packaging-projects and https://packaging.python.org/guides/distributing-packages-using-setuptools/#wheels say a word about that.
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 reading the Packaging Projects tutorial and the guide section on distributing packages with setuptools, especially their existing command examples. Add a clear note distinguishing commands such as python setup.py sdist and pip install something from Python code and explaining that they belong in a system console; confirm both referenced pages contain the clarification.
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
- Clearly specified
- Newbie friendliness
- 45/100