Improve namespace packaging guide #1379
Conversation
jeanas
left a comment
jeanas
left a comment
There was a problem hiding this comment.
LGTM.
When this is merged, I plan to submit a follow-up change adding tabs for build backends other than setuptools.
sinoroc
left a comment
sinoroc
left a comment
There was a problem hiding this comment.
Maybe it is a bigger change... but have you considered migrating the examples in this document to src layout?
As far as I know, with the src layout the build backends are able to automatically find the packages (namespace and regular), no configuration needed.
|
That #@**-%$!!! pre-commit blames me for typos my PR doesn't include! |
That is surprising. I have no idea why codespell did not trigger on those issues before... |
Well it did, but only after #1372 was merged. I guess that useless pre-commit-ci wasn't configured at the time that PR was opened. |
|
Thanks for reviewing, I addressed your comments!
I was unsure if I shouldn't just leave the examples under the Legacy namespace packages section alone, considering they're "archived"? |
And de-emphasize ``setup.py`` in favor of ``pyproject.toml``.
Co-authored-by: sinoroc <[email protected]>
chrysle
force-pushed
the
update-namespace-packaging-guide
branch
from
39307cd to
d5e97d8
Compare
for more information, see https://pre-commit.ci
Co-authored-by: sinoroc <[email protected]>
sinoroc
left a comment
sinoroc
left a comment
There was a problem hiding this comment.
Some more suggestions. Sorry that I am bringing yet another round of those instead of all at once... :/
And shorten `[build-system]` table. Co-authored-by: sinoroc <[email protected]>
|
@sinoroc Thank you for your thorough review! |
willingc
left a comment
willingc
left a comment
There was a problem hiding this comment.
This looks good to me. Thanks!
4 participants
This addresses the linked issues, and adds a
pyproject.tomlexample for how to find native or implicit namespace packages withsetuptools.__init__.pysyntax in namespace packaging guide #1305📚 Documentation preview 📚: https://python-packaging-user-guide--1379.org.readthedocs.build/en/1379/