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

Question

我想将./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...

我错过了什么？！

Answer 1

正如 cmets 中指出的，添加静态文件有两种方法：

1 - include_package_data=True + MANIFEST.in

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

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

在setup.py 中有include_package_data = True。

2 - setup.py 中的 package_data

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

指定setup.py中的文件。

---

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

include_package_data 将使package_data 信息无效。

官方文档：
https://setuptools.readthedocs.io/en/latest/userguide/datafiles.html

Answer 2

根据文档，有three ways 包含包数据文件。你有两个包裹：Potato 和 Tomato。静态目录不在这两个包中，所以这就是 setup.py 中的 package_data 字典不起作用的原因。 manifest 选项要求在 setup.py 中将 include_package_data 设置为 True。访问非包数据文件可以通过here找到的方式完成。

Answer 3

使用以下

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

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

Answer 4

递归包含所有文件：

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

其中project_name 是与setup.py 文件位于同一行的文件夹。