包含setup.py的非Python文件

Question

如何制作setup.py包含不属于代码的文件？(具体来说,它是一个许可证文件,但它可能是任何其他东西.)

我希望能够控制文件的位置.在原始源文件夹中,该文件位于包的根目录中.(即与最顶层处于同一级别__init__.py.)我希望它在安装软件包时保持完全无论操作系统如何.我怎么做？

Answer 1

可能最好的方法是使用该setuptools package_data指令.这意味着使用setuptools(或distribute)代替distutils,但这是一个非常无缝的"升级".

这是一个完整的(但未经测试的)示例:

from setuptools import setup, find_packages

setup(
    name='your_project_name',
    version='0.1',
    description='A description.',
    packages=find_packages(exclude=['ez_setup', 'tests', 'tests.*']),
    package_data={'': ['license.txt']},
    include_package_data=True,
    install_requires=[],
)

请注意这里至关重要的具体行:

package_data={'': ['license.txt']},
include_package_data=True,

package_data是一个dict包名称(空=所有包)到模式列表(可以包括globs).例如,如果您只想在包中指定文件,也可以这样做:

package_data={'yourpackage': ['*.txt', 'path/to/resources/*.txt']}

这里的解决方案绝对不是py用.py扩展名重命名您的非文件.

有关详细信息,请参阅Ian Bicking的演示文稿.

更新:另一个[更好]方法

如果您只想控制源分发(sdist)的内容并且包含在包之外的文件(例如顶级目录)的另一种方法是添加MANIFEST.in文件.有关此文件的格式,请参阅Python文档.

自编写此响应以来,我发现使用MANIFEST.in通常是一种不那么令人沮丧的方法来确保源分发(tar.gz)具有您需要的文件.

例如,如果要包含requirements.txt顶级,则递归地包含顶级"data"目录:

include requirements.txt
recursive-include data *

但是,为了将这些文件在安装时复制到site-packages中的软件包文件夹,您需要提供include_package_data=True给该setup()函数.有关更多信息,请参阅添加非代码文件.

Answer 2

要完成你所描述的将采取两个步骤......

• 该文件需要添加到源tarball中
• 需要修改setup.py以将数据文件安装到源路径

步骤1:要将文件添加到源tarball,请将其包含在MANIFEST中

在包含setup.py的文件夹中创建MANIFEST模板

MANIFEST基本上是一个文本文件,其中包含将包含在源tarball中的所有文件的列表.

以下是我的项目的MANIFEST:

• CHANGELOG.txt
• INSTALL.TXT
• LICENSE.TXT
• pypreprocessor.py
• 的README.txt
• setup.py
• test.py
• TODO.txt

注意:虽然sdist 会自动添加一些文件,但我更愿意明确指定它们,而不是预测它的作用和不作用.

步骤2:要将数据文件安装到源文件夹,请修改setup.py

由于您要将数据文件(LICENSE.txt)添加到源安装文件夹,因此需要修改数据安装路径以匹配源安装路径.这是必要的,因为默认情况下,数据文件安装在与源文件不同的位置.

修改数据安装目录以匹配源安装目录...

从distutils中提取安装目录信息:

from distutils.command.install import INSTALL_SCHEMES

修改数据安装目录以匹配源安装目录:

for scheme in INSTALL_SCHEMES.values():
    scheme['data'] = scheme['purelib']

并且,将数据文件和位置添加到setup():

data_files=[('', ['LICENSE.txt'])]

注意:上述步骤应完全按标准方式完成,无需任何扩展库.

Answer 3

现在是 2019 年，这是有效的 - 尽管到处都有建议，但我在互联网上发现的中途记录正在使用setuptools_scm，作为选项传递给setuptools.setup. 这将包括在您的 VCS 上进行版本控制的任何数据文件，无论是 git 还是任何其他文件，到轮包中，并将从 git 存储库进行“pip install”以带来这些文件。

所以，我只是将这两行添加到“setup.py”的设置调用中。无需额外安装或导入：

    setup_requires=['setuptools_scm'],
    include_package_data=True,

无需手动列出 package_data，或在 MANIFEST.in 文件中 - 如果它是版本化的，则它包含在包中。“setuptools_scm”上的文档强调从提交位置创建版本号，而忽略了添加数据文件的真正重要部分。（如果我的中间轮文件被命名为“*0.2.2.dev45+g3495a1f”或者将使用我输入的硬编码版本号“0.3.0dev0”，我不在乎 - 但为程序留下关键文件后面的工作有点重要）

Answer 4

MANIFEST.in在项目根目录中创建recursive-include所需目录或include文件名.

include LICENSE
include README.rst
recursive-include package/static *
recursive-include package/templates *

文档可以在这里找到

Answer 5

步骤1：MANIFEST.in在与setup.py相同的文件夹中创建一个文件

第 2 步：包含要添加的文件的相对路径MANIFEST.in

include README.rst
include docs/*.txt
include funniest/data.json

第3步：设置include_package_data=True在setup()功能将这些文件复制到站点包

参考在这里。

Answer 6

以上这些都不适合我。拯救我的是这个答案。
\n显然，为了在安装过程中提取这些数据文件，我必须做几件事：

\n

\n
1. 就像已经提到的 - 将 a 添加MANIFEST.in到项目并指定要包含的文件夹/文件。就我而言：recursive-include folder_with_extra_stuff *
\n
2. 再次，就像已经提到的 - 添加include_package_data=True到您的setup.py. *.py这很重要，因为没有它，只会带来匹配的文件。
\n
3. 这就是所缺少的！- 添加一个空的__init__.py数据文件夹。对我来说，我必须将此文件添加到我的folder-with-extra-stuff.
\n
4. 额外 - 不确定这是否是一个要求，但通过我自己的 python 模块，我看到它们被压缩在 .egg 文件中site-packages。所以我必须添加zip_safe=False到我的setup.py文件中。
\n

\n

最终目录结构

\n

my-app/\n\xe2\x94\x9c\xe2\x94\x80 app/\n\xe2\x94\x82  \xe2\x94\x9c\xe2\x94\x80 __init__.py\n\xe2\x94\x82  \xe2\x94\x9c\xe2\x94\x80 __main__.py\n\xe2\x94\x9c\xe2\x94\x80 folder-with-extra-stuff/\n\xe2\x94\x82  \xe2\x94\x9c\xe2\x94\x80 __init__.py\n\xe2\x94\x82  \xe2\x94\x9c\xe2\x94\x80 data_file.json\n\xe2\x94\x9c\xe2\x94\x80 setup.py\n\xe2\x94\x9c\xe2\x94\x80 MANIFEST.in\n

\n

Answer 7

我想对其中一个问题发表评论，但我没有足够的声誉来做到这一点 >.>

这是对我有用的（在参考文档后提出的）：

package_data={
    'mypkg': ['../*.txt']
},

include_package_data: False

奇怪的是，最后一行对我来说也很重要（你也可以省略这个关键字参数——它的工作原理是一样的）。

它的作用是复制您的顶级或根目录中的所有文本文件（mypkg您要分发的包的上一层）。

希望这可以帮助！

Answer 8

在setup.py下设置(:

setup(
   name = 'foo library'
   ...
  package_data={
   'foolibrary.folderA': ['*'],     # All files from folder A
   'foolibrary.folderB': ['*.txt']  #All text files from folder B
   },

Answer 9

这在 2020 年有效！

正如其他人所说，在您的 setup.py 所在的位置创建“MANIFEST.in”。

清单中的下一步包括/排除所有必要的东西。这里要注意语法。例如：假设我们有模板文件夹要包含在源包中。

在清单文件中这样做：

recursive-include template *

确保在 dir-name 和 pattern 之间为文件/目录留有空格，如上述。不要像我们在 .gitignore 中那样做

recursive-include template/* [this won't work]

其他选项是使用包括。有很多选择。在此处查看他们的 Manifest.in 文档

最后一个重要的步骤，在你的 setup.py 中包含这个参数，你就可以开始了！

   setup(
    ...
    include_package_data=True,
    ......
)

希望有帮助！快乐编码！