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

Mention find_namespace_package function in "Packaging namespace packages" guide. #580

Closed
feluxe opened this issue Dec 12, 2018 · 3 comments
Labels
good first issue help wanted type: enhancement A self-contained enhancement or new feature

Comments

@feluxe
Copy link

feluxe commented Dec 12, 2018

I was struggling with a namespace packge for a long time until I found out about setuptools.find_namespace_packages() in a github issue.

I think it would be nice if find_namespace_packages() was mentioned in this guide:

https://packaging.python.org/guides/packaging-namespace-packages/#packaging-namespace-packages

There is this section already:

Because mynamespace doesn’t contain an init.py, setuptools.find_packages() won’t find the sub-package. You must explicitly list all packages in your setup.py. For example:

I think it would be nice if it was updated to something like this:

Because mynamespace doesn’t contain an init.py, setuptools.find_packages() won’t find the sub-package. To get the sub-packages, you must either use setuptools.find_namespace_packages() or explicitly list all sub-packages in your setup.py. For example:

@theacodes theacodes added type: enhancement A self-contained enhancement or new feature good first issue help wanted labels Dec 14, 2018
@theacodes
Copy link
Member

Thanks for reporting this! This is a great first issue for someone. :)

plemelin added a commit to plemelin/packaging.python.org that referenced this issue Jul 5, 2019
…space_packages() to help packaging PEP 420 packages

fixes pypa#580
@plemelin
Copy link

plemelin commented Jul 5, 2019

@theacodes
I stumble upon this issue. After reading pypa/setuptools#97 I could not find any reference to find_namespace_packages other than the code itself. Hopefully the text suits the needs

@avaldebe
Copy link

It looks to me that this issue was addressed on #622, so you should be able to close it.

@di di closed this as completed Oct 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue help wanted type: enhancement A self-contained enhancement or new feature
Projects
None yet
5 participants