如何将静态文件包含到 setuptools-python 包中

我想包括 ./static/data.txt到 setuptools，这是我的代码:

# setup.py
import os,glob
from setuptools import setup,find_packages


setup(
name = "PotatoProject",
version = "0.1.1",
author = "Master Splinter",
author_email = "splinter@initech.com",
description = ("The potatoproject!"),
url = 'http://www.google.com',
license = "BSD",


# adding packages
packages=find_packages('src'),
package_dir = {'':'src'},


# trying to add files...
include_package_data = True,
package_data = {
'': ['*.txt'],
'': ['static/*.txt'],
'static': ['*.txt'],
},


scripts=['src/startPotato'],
classifiers=[
"Development Status :: 3 - Alpha",
"Topic :: Utilities",
"License :: OSI Approved :: BSD License",
],
)

文件系统:

.
├── setup.py
└── src
├── distutils_setup.py
├── Potato
│   ├── __init__.py
│   ├── potatoData.txt
│   └── printer.py
├── startPotato
├── static
│   └── data.txt
└── Tomato
├── big.py
└── __init__.py

运行时的输出: python setup.py sdist

running sdist
running egg_info
creating src/PotatoProject.egg-info
writing src/PotatoProject.egg-info/PKG-INFO
writing top-level names to src/PotatoProject.egg-info/top_level.txt
writing dependency_links to src/PotatoProject.egg-info/dependency_links.txt
writing manifest file 'src/PotatoProject.egg-info/SOURCES.txt'
reading manifest file 'src/PotatoProject.egg-info/SOURCES.txt'
writing manifest file 'src/PotatoProject.egg-info/SOURCES.txt'
warning: sdist: standard file not found: should have one of README, README.txt


creating PotatoProject-0.1.1
creating PotatoProject-0.1.1/src
creating PotatoProject-0.1.1/src/Potato
creating PotatoProject-0.1.1/src/PotatoProject.egg-info
creating PotatoProject-0.1.1/src/Tomato
making hard links in PotatoProject-0.1.1...
hard linking setup.py -> PotatoProject-0.1.1
hard linking src/startPotato -> PotatoProject-0.1.1/src
hard linking src/Potato/__init__.py -> PotatoProject-0.1.1/src/Potato
hard linking src/Potato/printer.py -> PotatoProject-0.1.1/src/Potato
hard linking src/PotatoProject.egg-info/PKG-INFO -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/PotatoProject.egg-info/SOURCES.txt -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/PotatoProject.egg-info/dependency_links.txt -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/PotatoProject.egg-info/top_level.txt -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/Tomato/__init__.py -> PotatoProject-0.1.1/src/Tomato
hard linking src/Tomato/big.py -> PotatoProject-0.1.1/src/Tomato
Writing PotatoProject-0.1.1/setup.cfg
creating dist
Creating tar archive
removing 'PotatoProject-0.1.1' (and everything under it)

没有文本添加! 没有 static/data.txt或 Potato/potatoData.txt..。

我错过了什么！

60957 次浏览
小开
最佳答案

As pointed out in the comments, there are 2 ways to add the static files:

1 - include_package_data=True + MANIFEST.in

A MANIFEST.in file in the same directory of setup.py that looks like this:

include src/static/*
include src/Potato/*.txt

With include_package_data = True in setup.py.

2 - package_data in setup.py

package_data = {
'static': ['*'],
'Potato': ['*.txt']
}

Specify the files inside the setup.py.

Do not use both include_package_data and package_data in setup.py.

include_package_data will nullify the package_data information.

Official docs:
https://setuptools.readthedocs.io/en/latest/userguide/datafiles.html

小开

Include all files recursively:

recursive-include project_name/templates *
recursive-include project_name/static *

where project_name is a folder in the same line where you have setup.py file.

小开

According to the docs, there are three ways to include package data files. You have two packages: Potato and Tomato. The static directory is not in either of those packages, so that is why your package_data dictionary in setup.py was not working. The manifest option requires that include_package_data is set to True in setup.py. Access non-package data files can be done the way found here.

小开

Use following

packages = ['.','templates','static','docs'],


package_data={'templates':['*'],'static':['*'],'docs':['*'],},

提交答案