python - 如何使用分发打包示例脚本？

Question

我使用分发来打包一个小型python库。我按照 Hitchhiker's Guide to Packaging 中的描述创建了一个目录结构。

我的问题：我在哪里（在目录结构中）放置示例脚本来展示如何使用库以及需要对setup.py?

Answer 1

我认为这很好，不要安装示例，而是您可以将examples文件夹与您的发行版一起保存，因此它可能与您的 setup.py 处于同一级别，

如果要包含它们，则将它们作为单独的包模块包含，例如“示例”-该目录包含所有示例脚本，即使在安装后用户也可以参考。

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

Answer 2

示例脚本是一种文档，因此安装它们的方式与安装其他文档的方式相同：作为 package_data。