使用setup.py包含非python文件

我如何使setup.py包含一个不是代码一部分的文件?(具体来说，它是一个许可证文件，但也可以是其他任何东西。)

我希望能够控制文件的位置。在原始源文件夹中，文件位于包的根目录中。(即与最顶层的__init__.py在同一层。)我希望它在安装包时保持在那里，而不管操作系统是什么。我怎么做呢?

当前回答

要实现你所描述的需要两步……

需要将该文件添加到源压缩文件中需要修改Setup.py，将数据文件安装到源路径

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

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

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

下面是我项目的MANIFEST:

CHANGELOG.txt INSTALL.txt LICENSE.txt pypreprocessor.py 固定 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'])]

注意:上面的步骤应该以标准的方式完成您所描述的工作，而不需要任何扩展库。

2010-06-15 04:00:06

其他回答

我只是想跟进我在Centos 6上的Python 2.7中发现的一些东西。如上所述，添加package_data或data_files对我不起作用。我加了一份清单。IN中有我想要的文件，这些文件将非python文件放入tarball中，但没有通过RPM将它们安装到目标机器上。

最后，我能够使用setup/setuptools中的“选项”将文件导入到我的解决方案中。选项文件允许您从setup.py修改规范文件的各个部分。如下。

from setuptools import setup


setup(
    name='theProjectName',
    version='1',
    packages=['thePackage'],
    url='',
    license='',
    author='me',
    author_email='me@email.com',
    description='',
    options={'bdist_rpm': {'install_script': 'filewithinstallcommands'}},
)

file - MANIFEST.in:

include license.txt

文件 - 文件与安装命令：

mkdir -p $RPM_BUILD_ROOT/pathtoinstall/
#this line installs your python files
python setup.py install -O1 --root=$RPM_BUILD_ROOT --record=INSTALLED_FILES
#install license.txt into /pathtoinstall folder
install -m 700 license.txt $RPM_BUILD_ROOT/pathtoinstall/
echo /pathtoinstall/license.txt >> INSTALLED_FILES

2015-06-01 17:22:40

创建清单。在项目根用递归include到所需目录或用文件名include。

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

文档可以在这里找到

2017-09-20 11:24:53

步骤1:创建MANIFEST。和setup.py在同一个文件夹里

步骤2:在MANIFEST.in中包含要添加的文件的相对路径

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

步骤3:在setup()函数中设置include_package_data=True，将这些文件复制到site-package

参考资料在这里。

2018-10-26 21:43:59

最好的方法可能是使用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是包名(空=所有包)到模式列表(可以包括glob)的字典。例如，如果你只想在你的包中指定文件，你也可以这样做:

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

这里的解决方案肯定不是用.py扩展名重命名非py文件。

更多信息请看Ian Bicking的演讲。

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

如果你只是想控制源分发(sdist)的内容，并且在包之外有文件(例如顶级目录)，另一种工作得很好的方法是添加一个MANIFEST。在文件中。有关此文件的格式，请参阅Python文档。

写完这篇文章后，我发现使用MANIFEST。In通常是一种不那么令人沮丧的方法，可以确保您的源发行版(tar.gz)有您需要的文件。

例如，如果你想包含顶层的requirements.txt，递归地包含顶层的"data"目录:

include requirements.txt
recursive-include data *

然而，为了在安装时将这些文件复制到site-packages内的包的文件夹中，您需要向setup()函数提供include_package_data=True。有关更多信息，请参见添加非代码文件。

2009-12-07 02:20:16