Including non-Python files without init.py using `package_data` in setup.py?

Question

Given this directory structure (empty __init__.py and logging.yml is fine):

foo
│   setup.py
│
└─── foo
     │   __init__.py
     │
     └─── config
              logging.yml

Here is my attempt, this setup.py:

from os import path
from setuptools import find_packages, setup

package_name = "foo"


if __name__ == "__main__":
    setup(
        name=package_name,
        packages=find_packages(),
        package_dir={package_name: package_name},
        package_data={"config":[path.join(package_name, "config", "logging.yml")]},
        include_package_data=True,
    )

# Also tried:
# package_data={"config": [path.join("config", "logging.yml")]}
# package_data={"": [path.join("config", "logging.yml")]}
# package_data={"": [path.join(package_name, "config", "logging.yml")]}

No errors after a python setup.py install (also tried python -m pip install .), but running from my virtualenv root fd -HIFuuueyml logging returns no results and it's absent from foo.egg-info\SOURCES.txt.

PS: Testing locally with 3.13.0a5; setuptools 69.2.0; pip 24.0. But on my CI test & release to 2.7, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12 across Windows, Linux and macOS.

That part is wrong regardless of package data: package_dir={package_name: package_name}. See the docs at setuptools.pypa.io/en/latest/userguide/package_discovery.html . With your dir structure you don't need package_dir at all; my advice is to remove the line. — phd
– phd, Commented Mar 30, 2024 at 13:08
With package_data={"config":… you declare that config is a package. But it isn't. So the answer for the question in the title is: no. Again, the docs: setuptools.pypa.io/en/latest/userguide/datafiles.html — phd
– phd, Commented Mar 30, 2024 at 13:10
@phd - In my comment I specify the other ways I did package_data. I'll try removing package_dir and see if that fixes this. EDIT: Nope, that didn't work either. Tried all permutations of package_data enumerated in my question. — Samuel Marks
– Samuel Marks, Commented Mar 30, 2024 at 15:01

phd · Accepted Answer · 2024-03-30 16:22:40Z

1

This works:

from setuptools import find_packages, setup

package_name = "foo"


if __name__ == "__main__":
    setup(
        name=package_name,
        packages=find_packages(),
        package_data={"foo": ["config/logging.yml"]},
        include_package_data=True,
    )

You have only 1 (one) package foo, so your package_data should be for this package.

answered Mar 30, 2024 at 16:22

phd

97.2k14 gold badges165 silver badges223 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Samuel Marks Over a year ago

Oh wow I finally found my logging.yml. It's in C:\[dir]\Python\Python313\Lib\site-packages\foo rather than [virtualenv]\Lib\site-packages\foo. Even though my virtualenv is definitely activated. Hmm.

Samuel Marks Over a year ago

Ok with py on Windows this works on 3.13.0a5 and 2.7.18. Thanks

phd Over a year ago

@SamuelMarks Somehow you installed the package globally and not in the [virtualenv]. If you manage to install it in the [virtualenv] you will surely find the data file at [virtualenv]\Lib\site-packages\foo\config\logging.yml

Samuel Marks Over a year ago

Yeah Windows was acting weird. python.exe was definitely in the [virtualenv] but it installed packages globally. Switching to py within the activated virtualenv solved the issue.

Collectives™ on Stack Overflow

Including non-Python files without init.py using `package_data` in setup.py?

1 Answer 1

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related