我正在为PyPi打包我的新 python 库。存储库包含：
- Sphinx 文档来源
- 补充 JavaScript 库
- 例子
将这些东西包含在python 鸡蛋中是个好主意吗？什么是约定？
问问题
166 次
3 回答
2
您不应将所有内容都放入 python 蛋中，但无论如何，这取决于python setup.py bdist_egg选择包含或不包含的内容。但是在你上传到pypi的源码包中，是的，包括setup.py不能生成的所有东西。您可以单独上传文档，因此也可以发布。
但一般来说，您需要包含在鸡蛋中的是鸡蛋按原样运行所必需的。其他所有内容都可以包含在内，但可以通过其他方式分发，这取决于您。
于 2013-05-08T15:12:34.077 回答
1
PyPI 上有一些完全（或几乎）完全用 bash 编写的包（virtualenvwrapper.sh 就是其中之一）。
如果有一个可以打包的补充 JavaScript 库，那将不是一件坏事。这可以防止用户可能没有安装 npm 的情况，因此它使您的库更易于使用并且您的用户更快乐。
不需要包含文档，但是如果您愿意，请务必这样做。库包括和不包括文档。github3.py现在包含它，而requests没有。这取决于你的喜好。
我个人在文档中总是有示例，因此它们包含在包含文档的包中。我想不出任何包含单独示例包的包，但是如果您认为有必要，请继续。不过，我可能会将其设为库本身的子目录。它会在安装时使名称间距更好。
但基本上，除了让代码执行您所说的包将执行的任务之外，没有固定的约定。
于 2013-05-08T15:03:56.890 回答
0
我可以告诉 PyQT4：
它包括文档、示例、插件、...
我不知道您的 JavaScript 库，但我认为包含它也没有问题。
这是一个例子——我不知道惯例。我会把所有对你图书馆的用户很重要的东西都放进去。
于 2013-05-07T16:35:34.807 回答