我正在为 PyPi 打包我的新python库。存储库包含:
将这些内容包含在 python egg 中是个好主意吗? 惯例是什么?
看到图书馆的内容答案 0 :(得分:2)
你不应该把所有东西都变成蟒蛇蛋,但无论如何,由python setup.py bdist_egg
选择包括或不包含的东西。但是在你上传到pypi的源包中,是的,包括setup.py无法生成的所有内容。您可以单独上传文档,因此也可以发布。
但一般来说,你需要包含在鸡蛋中的是鸡蛋按原样运行所必需的东西。其他所有内容都可以包含在内,但可以通过其他方式进行分发,这取决于您。
尝试聪明并且有常识!
答案 1 :(得分:1)
PyPI上的软件包完全(或几乎)完全用bash编写(virtualenvwrapper.sh就是一个)。
如果有一个可以打包的补充JavaScript库,这不会是件坏事。这可以防止用户可能没有安装npm的情况,因此它使您的库更易于使用,并且您的用户更快乐。
文档不需要包含但如果您愿意,那么请务必执行此操作。图书馆既包括也包括文档。 github3.py现在包括它,而requests则没有。这取决于您的偏好。
我个人总是在文档中有示例,因此它们包含在我的包中,其中包含文档。我想不出任何包含一个单独的示例包的顶级软件包,但如果您认为有必要,那么请继续。但是,我可能会将其作为库本身的子目录。它将使名称间距在安装时更好。
但基本上,除了让代码执行您说包将执行的任务之外,没有任何约定。
祝你好运!我希望你的包装很受欢迎!答案 2 :(得分:0)
我可以告诉PyQT4:
它包括doc,examples,plugins,...
我不知道你的JavaScript库,但我认为包含它也没问题。
这是一个例子 - 我不知道惯例。我会把对你的图书馆用户来说很重要的一切都放进去。