如何在没有MANIFEST.in文件的情况下包含package_data?

时间:2015-03-13 16:07:42

标签: python manifest packaging setuptools setup.py

如果没有MANIFEST.in文件,如何为package_data添加sdist

我的setup.py看起来像这样:

import setuptools

setuptools.setup(
    name='foo',
    version='2015.3',
    license='commercial',
    packages=setuptools.find_packages(),

    package_data={'': ['foo/bar.txt']},
)

版本:

user@host> python
Python 2.7.6 (default, Mar 22 2014, 22:59:56) 
>>> import setuptools
>>> setuptools.version.__version__
'3.6'

我无法获得foo/bar.txt

或者this blog post仍然是真的吗? http://blog.codekills.net/2011/07/15/lies,-more-lies-and-python-packaging-documentation-on--package_data-/

但是,在过去的一小时里,我了解到这些陈述介于“危险的误导”和“该死的谎言”之间。 这是因为Python包的主要类型是源包,而创建源包的规范方法是使用setup.py sdist。但是,package_data中指定的数据不包含在源代码分发中 - 它们仅包含在二进制(setup.py bdist)分发和安装中(setup.py install)。

如果没有MANIFEST.in文件,如何为package_data添加sdist

2 个答案:

答案 0 :(得分:40)

TL; DR package_data词典中的键是;值是globs列表。 ''不是任何Python包的有效名称。

如果您希望在bar.txt__init__.py旁边安装foo,请使用

 package_data={'foo': ['bar.txt']}

我有布局:

foo/
        __init__.py
        bar.txt
setup.py

现在,如果foo是上面的包,请执行:

import setuptools

setuptools.setup(
    name='foo',
    version='2015.3',
    license='commercial',
    packages=setuptools.find_packages(),
    package_data={'foo': ['bar.txt']},
)

python setup.py sdist之后,我会检查dist/foo-2015.3.tar.gz

的内容
% tar tfz dist/foo-2015.3.tar.gz
...
foo-2015.3/foo/bar.txt
...

但是,如果我使用setup.py运行package_data={'': ['foo/bar.txt']},我可以同意foo/bar.txt添加到源代码分发中,除非foo-2015.3.egg-info/SOURCES.txt已经包含foo/bar.txt行 - 在这种情况下,文件也会在源代码分发中弹出

没有使用任何清单; setuptools版本是3.6(我故意安装了你正在使用的旧版本):

>>> import setuptools
>>> setuptools.__version__
'3.6'

上述行为也适用于"遗产"的标准distutils2.6 Installing package data。 distutils文件;评论为2.7,3.1:

  

版本 [2.7,3.1] 更改:如果没有提供模板,则所有匹配package_data的文件都会添加到MANIFEST文件

答案 1 :(得分:12)

我遇到了同样的问题并修复了删除:

include_package_data=True