如何在 pip(pypi) 模块中包含 txt 文件

Question

我创建了一个 pip 模块并将该模块安装在 jupyter notebook 中。

由于以下原因，有一个功能不起作用。

我创建了一个 pip 模块，在这个模块中我还有一个文本文件，其中包含工具箱所需的一些信息。

但是当我创建pypi模块时，这个txt文件并没有转换成python wheel，现在安装后找不到这个txt文件。

有没有办法在这个模块中包含一个 txt 文件，或者我是否需要将此 txt 文件转换为另一种格式（.csv？）。

Answer 1

你可能调用setuptools.setup您的setup.py文件包中的代码。setup 决定将哪些文件包含在轮子中的逻辑，虽然它主要是开箱即用的，但有点复杂。

在您的情况下，将您的文件路径添加.csv到package_data-list就足够了：

from setuptools import setup

setup(
    ...                                      # "name" and stuff
    packages=['mypkg'],                      # root folder of your package
    package_dir={'mypkg': 'src/mypkg'},      # directory which contains the python code
    package_data={'mypkg': ['data/*.csv']},  # directory which contains your csvs
)

关于使用MANIFEST，而不是package_data文档页面谈论的参数，因为您用于wheel构建包，所以应该没问题。wheel默认情况下使用 bdist，它适用于package_data.