How to include other static files when only using extension modules

[houxinlin]

I only use ext_modules, not package. I want to package it as. pyd, but I encountered an issue where I cannot include other static files。

This is my setup function

from distutils.core import setup, Extension

setup(
    name="my_package",
    version="0.1",
    include_package_data=True,
    ext_modules=[Extension("my_package.test", ["my_package/test.py"])]
)

I want to package pdf/book.pdf to the my_mackage directory after executing the build task。

I tried to add data_files=[("book", ["my_package/pdf/book.pdf"])],, but it didn't work

MANIFEST.in

recursive-include my_package/pdf *.pdf

[agammann]

Your screenshot already has my_package/__init__.py, so you can declare that directory as a package and include the PDF as package data. include_package_data=True alone does not declare a package for build_py to process.

Use setuptools imports and add these settings to setup():

from setuptools import setup, Extension

setup(
    name="my_package",
    version="0.1",
    packages=["my_package"],
    package_data={"my_package": ["pdf/*.pdf"]},
    ext_modules=[Extension("my_package.test", ["my_package/test.c"])],
)

The example uses the generated test.c visible in your screenshot. If you retain test.py as the extension source, keep your Cython build step and its build dependency instead. The package/data settings apply in either case.

data_files chooses a separate installation destination; package_data places the file inside my_package/pdf/, where you can read it with:

from importlib.resources import files

pdf = files("my_package").joinpath("pdf/book.pdf").read_bytes()

I built and installed matching C and Cython examples with setuptools 84.0.0 on Linux; both wheels contained the compiled extension and my_package/pdf/book.pdf, and the installed resource was readable. The Cython example used Cython 3.3.0 and a .py extension source.

Declaring a package also copies its Python modules. If you need the compiled test module without test.py in the wheel, put the extension source outside the declared package directory; I checked that layout too. See Data Files Support.