packaging.python.org icon indicating copy to clipboard operation
packaging.python.org copied to clipboard

Explain clearly that python / pip / other commands are not Python code

Open merwok opened this issue 5 years ago • 2 comments

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.

merwok avatar Jun 19 '20 21:06 merwok

+1 on helping people to better understand this distinction - it's common (maybe more so on Windows?) to see people who don't understand the idea of a shell trying to work with the packaging guides, and this is foundational knowledge that we assume in a lot of places.

I'd prefer it if we provided a brief summary plus pointers to resources that people could use to understand the concepts of shell, REPL, and interactive command line program better. Going into too much depth in the packaging documentation feels like a digression (no matter how necessary) to me.

pfmoore avatar Jun 20 '20 11:06 pfmoore

I think the ideal thing then would be to link to a section of Python Setup and Usage in the official docs.

merwok avatar Jun 20 '20 17:06 merwok