Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Should the docs promote pip wheel . over python setup.py bdist_wheel? #424

Closed
nchammas opened this issue Oct 22, 2021 · 3 comments · Fixed by #439
Closed

Should the docs promote pip wheel . over python setup.py bdist_wheel? #424

nchammas opened this issue Oct 22, 2021 · 3 comments · Fixed by #439

Comments

@nchammas
Copy link

My knowledge of packaging conventions may be out of date, but I understand that directly invoking setup.py is something users should migrate away from since a) in the future it may disappear entirely and b) it has various historical quirks.

The docs for wheel still show python setup.py bdist_wheel as the way to build wheels. Should they be updated to call pip wheel . instead? Or is there some intended difference between these two commands?

@agronholm
Copy link
Contributor

The wheel docs are not the authoritative documentation for Python packaging. The authoritative documentation can be found at packaging.python.org. I will review the wheel docs and update as necessary when I am done with the more urgent work in my other projects.

@henryiii
Copy link
Contributor

They should show pipx run build --wheel or python -m pip install build && python -m build --wheel, I think. They probably shouldn't show setup.py commands (https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html), but then again, this is likely more focused on how things work for developers more than user facing docs. Internally, that's still the command name, even if users shouldn't be running it.

@hugovk
Copy link
Contributor

hugovk commented Jan 10, 2022

Please see PR #439.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants