如何将静态文件包含在安装工具 - python包中

Question

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

# setup.py
import os,glob
from setuptools import setup,find_packages
setup(
    name = "PotatoProject",
    version = "0.1.1",
    author = "Master Splinter",
    author_email = "[e-mail]",
    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

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

1 - include_package_data=真 + MANIFEST.in

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

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

随着include_package_data = True在setup.py.

2 - package_data in setup.py

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

递归包含所有文件：

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

其中project_name是与您拥有文件的同一行中的文件夹setup.py。

Answer 3

使用以下

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

Answer 4

根据文档，有三种方法可以包含包数据文件。您有两个包装：土豆和番茄。静态目录不在这些包中的任何一个中，因此这就是 setup.py 中的package_data字典不起作用的原因。清单选项要求在 setup.py 中将include_package_data设置为 True。可以按此处找到的方式访问非包数据文件。

Answer 5

给定这样的项目结构：

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

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

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

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