我如何使setup.py包含一个不是代码一部分的文件?(具体来说,它是一个许可证文件,但也可以是其他任何东西。)
我希望能够控制文件的位置。在原始源文件夹中,文件位于包的根目录中。(即与最顶层的__init__.py在同一层。)我希望它在安装包时保持在那里,而不管操作系统是什么。我怎么做呢?
我如何使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'])]
注意:上面的步骤应该以标准的方式完成您所描述的工作,而不需要任何扩展库。
其他回答
要实现你所描述的需要两步……
需要将该文件添加到源压缩文件中 需要修改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'])]
注意:上面的步骤应该以标准的方式完成您所描述的工作,而不需要任何扩展库。
这在2020年有效!
正如其他人所说,创造“显化”。在“setup.py所在的位置”。
接下来在manifest中包含/排除所有必要的东西。这里要注意语法。 例如:假设我们有模板文件夹要包含在源包中。
在manifest文件中这样做:
recursive-include template *
确保像上面那样在文件/dirs的dir-name和pattern之间留有空格。 不要像我们在gitignore那样做
recursive-include template/* [this won't work]
其他选项是使用include。有很多选择。看看他们的Manifest.in文件
最后重要的一步是,在setup.py中包含这个参数,然后就可以开始了!
setup(
...
include_package_data=True,
......
)
希望有帮助!编码快乐!
以上这些方法对我都不起作用。是这个回答救了我。 显然,为了在安装期间提取这些数据文件,我必须做几件事:
Like already mentioned - Add a MANIFEST.in to the project and specify the folder/files you want to be included. In my case: recursive-include folder_with_extra_stuff * Again, like already mentioned - Add include_package_data=True to your setup.py. This is crucial, because without it only the files that match *.py will be brought. This is what was missing! - Add an empty __init__.py to your data folder. For me I had to add this file to my folder-with-extra-stuff. Extra - Not sure if this is a requirement, but with my own python modules I saw that they're zipped inside the .egg file in site-packages. So I had to add zip_safe=False to my setup.py file.
最终目录结构
my-app/
├─ app/
│ ├─ __init__.py
│ ├─ __main__.py
├─ folder-with-extra-stuff/
│ ├─ __init__.py
│ ├─ data_file.json
├─ setup.py
├─ MANIFEST.in
这里有一个对我有用的更简单的答案。
首先,根据上面Python Dev的注释,setuptools是不需要的:
package_data is also available to pure distutils setup scripts
since 2.3. – Éric Araujo
这很好,因为在包中添加setuptools要求意味着您也必须安装它。简而言之:
from distutils.core import setup
setup(
# ...snip...
packages = ['pkgname'],
package_data = {'pkgname': ['license.txt']},
)
现在是2019年,以下是行之有效的方法 尽管这里和那里的建议,我在互联网上发现的是使用setuptools_scm,作为选项传递给setuptools.setup。这将包括VCS中版本化的任何数据文件,无论是git还是其他任何文件,到wheel包中,并将从git存储库中进行“pip install”以将这些文件带进来。
因此,我只是在“setup.py”的设置调用中添加了这两行。无需额外安装或导入:
setup_requires=['setuptools_scm'],
include_package_data=True,
No need to manually list package_data, or in a MANIFEST.in file - if it is versioned, it is included in the package. The docs on "setuptools_scm" put emphasis on creating a version number from the commit position, and disregard the really important part of adding the data files. (I can't care less if my intermediate wheel file is named "*0.2.2.dev45+g3495a1f" or will use the hardcoded version number "0.3.0dev0" I've typed in - but leaving crucial files for the program to work behind is somewhat important)