-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Description
Hi, firstly, thanks for the work you maintainers do on this library :)
I could be incorrect in saying this, but it's come to my understanding that setting include_package_data=True in setup includes data files specified by MANIFEST.in and only in MANIFEST.in. At the very least, this behaviour is not clearly explained in the docs, and at the worst it is unexpected and implicit behaviour.
Here is a sentence from the docs which seems to be trying to say the above, although elsewhere in the docs include_package_data is not explained in this way:
If using the setuptools-specific
include_package_dataargument, files specified bypackage_datawill not be automatically added to the manifest unless they are listed in the MANIFEST.in file.
Doesn't this make package_data redundant when include_package_data is True? Does it really make sense to have a param called include_package_data which implicitly ignores package_data?
In summary, this is the behaviour I seem to have come across when using these options in various combinations:
- Including files in
package_datawithinclude_package_data=False:- Files specified by
package_dataare included as well as everything in MANIFEST.in.
- Files specified by
- Including files in
package_datawithinclude_package_data=True:- Only the files specified by MANIFEST.in are included, files in
package_datanot specified by MANIFEST.in are excluded.
- Only the files specified by MANIFEST.in are included, files in
- Omitting
package_datawithinclude_package_data=True:- Same result as point 2.
I'm sorry if I've got this wrong, any correspondence is much appreciated :)