[BUG] `[options.package_data]` in setup.cfg does nothing

setuptools version

57.0.0

Python version

3.9.5

OS

Arch

Additional environment information

No response

Description

I have this project: https://gitlab.com/greyltc/runpanel/-/tree/a93fac114f5443dc5ae55b9a8eb395b3244e282b

It has a setup.cfg file with

[options]
include_package_data = True

and

[options.package_data]
runpanel = *.yaml

As you can see from the repo there, there’s a system_config.yaml file present that I expect to be included as package data. But after I install the package, and run

import importlib.resources
list(importlib.resources.contents('runpanel'))

I get only ['__pycache__', '__init__.py', '__main__.py', 'app.py', 'sysdbus.py']. There’s no yaml file.

Expected behavior

I expect that when I follow the packaging docs for including package_data files here: https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html?highlight=package_data that data should make it into my package.

How to Reproduce

1. Install my project here https://gitlab.com/greyltc/runpanel/-/tree/a93fac114f5443dc5ae55b9a8eb395b3244e282b
2. Notice that there are no .yaml package data files included

Output

$ ipython
In [1]: import importlib.resources
   ...: list(importlib.resources.contents('runpanel'))
Out[1]: ['__pycache__', '__init__.py', '__main__.py', 'app.py', 'sysdbus.py']

Code of Conduct

• I agree to follow the PSF Code of Conduct

[abravalheri]

Ah, I see, I missed that the files have to be in the package folder. I’ll stick to MANIFEST.in then.

Sorry if that is confusing in the docs: https://setuptools.pypa.io/en/latest/userguide/datafiles.html

Both include_package_data and package_data will only work with files inside the package directory (not the root of the project).

[kwinkunks]

Thank you very much for this explanation, and thanks for everything you’re doing to make packaging easier.

Re the docs, at the top of the page it says this:

First, you can simply use the include_package_data keyword […] This tells setuptools to install any data files it finds in your packages. The data files must be specified via the distutils MANIFEST.in file.

But that did not work for me. The only thing that worked, and it worked on its own (without either include_package_data or MANIFEST.in), was options.package_data.

I am using only setup.cfg, with only the package name being set in setup.py, so I’m not 100% certain I’m mapping the advice on this page (which all seems to use setup()) to my situation.

I need to look at setuptools_scm… I have not been paying attention to it.