如何将静态文件包含到setuptools-python包中

问题描述：

我想包含./static/data.txt，setuptools这是我的代码：

# 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",
    ],
)

文件系统：

.
├── setup.py
└── src
    ├── distutils_setup.py
    ├── Potato
    │   ├── __init__.py
    │   ├── potatoData.txt
    │   └── printer.py
    ├── startPotato
    ├── static
    │   └── data.txt
    └── Tomato
        ├── big.py
        └── __init__.py

运行时的输出：python setup.py sdist

running sdist
running egg_info
creating src/PotatoProject.egg-info
writing src/PotatoProject.egg-info/PKG-INFO
writing top-level names to src/PotatoProject.egg-info/top_level.txt
writing dependency_links to src/PotatoProject.egg-info/dependency_links.txt
writing manifest file 'src/PotatoProject.egg-info/SOURCES.txt'
reading manifest file 'src/PotatoProject.egg-info/SOURCES.txt'
writing manifest file 'src/PotatoProject.egg-info/SOURCES.txt'
warning: sdist: standard file not found: should have one of README, README.txt

creating PotatoProject-0.1.1
creating PotatoProject-0.1.1/src
creating PotatoProject-0.1.1/src/Potato
creating PotatoProject-0.1.1/src/PotatoProject.egg-info
creating PotatoProject-0.1.1/src/Tomato
making hard links in PotatoProject-0.1.1...
hard linking setup.py -> PotatoProject-0.1.1
hard linking src/startPotato -> PotatoProject-0.1.1/src
hard linking src/Potato/__init__.py -> PotatoProject-0.1.1/src/Potato
hard linking src/Potato/printer.py -> PotatoProject-0.1.1/src/Potato
hard linking src/PotatoProject.egg-info/PKG-INFO -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/PotatoProject.egg-info/SOURCES.txt -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/PotatoProject.egg-info/dependency_links.txt -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/PotatoProject.egg-info/top_level.txt -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/Tomato/__init__.py -> PotatoProject-0.1.1/src/Tomato
hard linking src/Tomato/big.py -> PotatoProject-0.1.1/src/Tomato
Writing PotatoProject-0.1.1/setup.cfg
creating dist
Creating tar archive
removing 'PotatoProject-0.1.1' (and everything under it)

也没有添加 txt！没有static/data.txt也没有Potato/potatoData.txt...

我错过了什么？！

解决方案 1：

正如评论中指出的那样，有两种方法可以添加静态文件：

1-include_package_data = True + MANIFEST.in

MANIFEST.in同一目录中的文件如下setup.py所示：

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

之include_package_data = True内setup.py。

2 - setup.py 中的 package_data

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

指定里面的文件setup.py。

不要在 中同时使用include_package_data和。package_data`setup.py`

include_package_data将使该package_data信息无效。

官方文档：

https：//setuptools.readthedocs.io/en/latest/userguide/datafiles.html

解决方案 2：

递归包含所有文件：

recursive-include project_name/templates *
recursive-include project_name/static *

文件夹project_name与文件位于同一行setup.py。

解决方案 3：

使用以下

packages = ['.','templates','static','docs'],

package_data={'templates':['*'],'static':['*'],'docs':['*'],},

解决方案 4：

根据文档，有三种方法可以包含包数据文件。您有两个包：Potato 和 Tomato。这两个包中都没有静态目录，因此 setup.py 中的 package_data 字典不起作用。manifest 选项要求在 setup.py 中将 include_package_data 设置为 True。可以按照此处找到的方式访问非包数据文件。

解决方案 5：

给定一个如下的项目结构：

.
├── setup.py
└── your_package
    ├── __init__.py
    ├── (code etc)
    └── static
        ├── a.txt
        ├── b.txt
        └── docs
            ├── a.rst
            └── b.rst

要递归地包含下的所有文件static，请在您的中添加以下内容setup.py（您不需要在文件夹__init__.py内添加任何文件static）：

setup(
    ...
    package_data={"your_package": ["static/**/*"]},
)

递归 glob**/*需要setuptools>=62.3.0：https://stackoverflow.com/a/55432314/2111778 https://stackoverflow.com/a/64789489/2111778