如何使用distribute打包示例脚本？

Question

我用 distribute 来打包一个小的 Python 库。我按照 《打包指南》的说明 创建了一个目录结构。

我想问的是：在这个目录结构中，我应该把示例脚本放在哪里，这些脚本用来展示如何使用这个库？还有，我需要对 setup.py 做哪些修改？

Answer 1

示例脚本是一种文档，所以你可以像安装其他文档一样来安装它们：作为 package_data。

Answer 2

我觉得不安装示例代码是个好主意，反而可以把你的 examples 文件夹和你的程序放在一起，这样它就和你的 setup.py 文件在同一个层级。

如果你想包含这些示例，那就把它们作为一个单独的模块放在包里，比如叫 'example'，然后这个目录里放所有的示例脚本，用户在安装后也可以查看这些示例。

package_data = {
        'module_1': [files],
        'module_2': [files],
        'example': [files],
}