How include static files to setuptools - python package

Question

I want to include the `./static/data.txt` to `setuptools`, here is my code: ``` # setup.py import os,glob from setuptools import setup,find_packages setup( name = "PotatoProject", version = "0.1.1", author = "Master Splinter", author_email = "splinter@initech.com", description = ("The potatoproject!"), url = 'http://www.google.com', license = "BSD", # adding packages packages=find_packages('src'), package_dir = {'':'src'}, # trying to add files... include_package_data = True, package_data = { '': ['*.txt'], '': ['static/*.txt'], 'static': ['*.txt'], }, scripts=['src/startPotato'], classifiers=[ "Development Status :: 3 - Alpha", "Topic :: Utilities", "License :: OSI Approved :: BSD License", ], ) ``` The file system: ``` . ├── setup.py └── src ├── distutils_setup.py ├── Potato │ ├── __init__.py │ ├── potatoData.txt │ └── printer.py ├── startPotato ├── static │ └── data.txt └── Tomato ├── big.py └── __init__.py ``` the output when running: `python setup.py sdist` ``` running sdist runn…

Accepted Answer

As pointed out in the comments, there are 2 ways to add the static files:

1 - include_package_data=True + MANIFEST.in

A `MANIFEST.in` file in the same directory of `setup.py` that looks like this:

```
include src/static/*
include src/Potato/*.txt
```

With `include_package_data = True` in `setup.py`.

2 - package_data in setup.py

```
package_data = {
    'static': ['*'],
    'Potato': ['*.txt']
}
```

Specify the files inside the `setup.py`.

Do not use both `include_package_data` and `package_data` in `setup.py`.

`include_package_data` will nullify the `package_data` information.

Official docs: https://setuptools.readthedocs.io/en/latest/userguide/datafiles.html

How include static files to setuptools - python package

Solution

Problem

Related problems