-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Improve namespace packaging guide #1379
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
When this is merged, I plan to submit a follow-up change adding tabs for build backends other than setuptools.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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]>
39307cd
to
d5e97d8
Compare
for more information, see https://pre-commit.ci
Co-authored-by: sinoroc <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some more suggestions. Sorry that I am bringing yet another round of those instead of all at once... :/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I approve, I have no reason to block this.
And shorten `[build-system]` table. Co-authored-by: sinoroc <[email protected]>
@sinoroc Thank you for your thorough review! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me. Thanks!
This addresses the linked issues, and adds a
pyproject.toml
example for how to find native or implicit namespace packages withsetuptools
.__init__.py
syntax in namespace packaging guide #1305📚 Documentation preview 📚: https://python-packaging-user-guide--1379.org.readthedocs.build/en/1379/