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

Improve namespace packaging guide #1379

Merged
merged 8 commits into from
Nov 14, 2023

Conversation

chrysle
Copy link
Contributor

@chrysle chrysle commented Nov 12, 2023

This addresses the linked issues, and adds a pyproject.toml example for how to find native or implicit namespace packages with setuptools.


📚 Documentation preview 📚: https://python-packaging-user-guide--1379.org.readthedocs.build/en/1379/

Copy link
Contributor

@jeanas jeanas left a 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.

Copy link
Contributor

@sinoroc sinoroc left a 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.

source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
@chrysle
Copy link
Contributor Author

chrysle commented Nov 12, 2023

That #@**-%$!!! pre-commit blames me for typos my PR doesn't include!

@sinoroc
Copy link
Contributor

sinoroc commented Nov 12, 2023

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...

@chrysle
Copy link
Contributor Author

chrysle commented Nov 12, 2023

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.

@chrysle
Copy link
Contributor Author

chrysle commented Nov 12, 2023

Thanks for reviewing, I addressed your comments!

Maybe it is a bigger change... but have you considered migrating the examples in this document to src layout?

I was unsure if I shouldn't just leave the examples under the Legacy namespace packages section alone, considering they're "archived"?

source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
@chrysle chrysle force-pushed the update-namespace-packaging-guide branch from 39307cd to d5e97d8 Compare November 13, 2023 09:21
Copy link
Contributor

@sinoroc sinoroc left a 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... :/

source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
source/guides/packaging-namespace-packages.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@sinoroc sinoroc left a 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.

@chrysle
Copy link
Contributor Author

chrysle commented Nov 14, 2023

@sinoroc Thank you for your thorough review!

Copy link
Contributor

@willingc willingc left a 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!

@willingc willingc enabled auto-merge November 14, 2023 17:42
@willingc willingc added this pull request to the merge queue Nov 14, 2023
Merged via the queue into pypa:main with commit a918470 Nov 14, 2023
@chrysle chrysle deleted the update-namespace-packaging-guide branch November 14, 2023 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants