PyPi包中包含哪些内容？

Question

我正在为PyPi打包新的python库。储存库包括：

• 狮身人面像文件来源
• 补充JavaScript文库
• 示例

在python 中包含这样的东西是个好主意吗？什么会议？

你可以在https://github.com/peterhudec/authomatic看到这个库的核心。

Answer 1

您不应该将所有东西都放入python蛋中，但是无论如何，这取决于python setup.py bdist_egg来选择包含什么内容。但是在上传到pypi的源代码包中，是的，包含了setup.py无法生成的所有内容。您可以单独上传文档，这样它也可以发布。

但是一般来说，需要才能包含在鸡蛋中，这是鸡蛋正常运行所必需的。其他一切都可以包括在内，但也可以通过其他方式分发，这取决于您。

Answer 2

PyPI上有一些包是完全用bash编写的(或几乎) (virtualenvwrapper.sh是其中之一)。

如果有一个可以打包的补充JavaScript库，那也不是坏事。这避免了用户可能没有安装npm的情况，因此它使您的库更易于使用，您的用户更快乐。

不需要包含文档，但是如果您想要，那么无论如何都要这样做。库包括和不包括文档。github3.py现在包括它，而请求没有。这取决于你的喜好。

我个人在文档中总是有示例，所以它们包含在包含文档的包中。我想不出我头顶上有一个单独的例子包，但是如果你觉得有必要，那就去做吧。不过，我可能会把它作为库本身的子目录。当安装时，它将使名称间距更好。

但基本上，除了让代码执行您说包将执行的任务之外，没有任何设置约定。

Answer 3

我能告诉PyQT4的是：

包括医生，例子，插件，.

我不知道您的JavaScript库，但我认为也没有问题。

这就是一个例子--我不知道这个惯例。我会把所有可能对你的库的用户很重要的东西都放进去。