什麼包含在PyPi包中？

Question

我打包我的新python庫爲PyPi。該庫包含：

• 獅身人面像的文檔資源
• 補充JavaScript庫
• 例子

這是個好主意，包括這樣的事情爲蟒蛇蛋？ 什麼是約定？

您可以在https://github.com/peterhudec/authomatic

Answer 1

看到該庫的膽量，我可以告訴什麼PyQt4的：

它包括文檔，示例，插件，...

我不知道你的JavaScript庫，但我認爲包括它也沒有問題。

這是一個例子 - 我不知道約定。我會把所有對你的圖書館用戶都很重要的東西放進去。

Answer 2

PyPI上有整個（或幾乎）完全寫在bash中的軟件包（virtualenvwrapper.sh是一個）。

如果有可以打包的補充JavaScript庫，那不會是件壞事。這可以防止用戶可能沒有安裝npm的情況，所以它使您的圖書館更易於使用，並且您的用戶更快樂。

文件不需要包含，但如果你想要，那麼盡一切辦法做到這一點。圖書館既包括也不包括文件。 github3.py現在包含它，而requests沒有。這取決於你的偏好。

我個人總是在文檔中有這些例子，所以它們被包含在我的包含文檔的包中。我想不出任何包含單獨包例子的頭頂包，但如果你覺得這是必要的，那就繼續吧。不過，我可能會把它作爲庫本身的一個子目錄。它會在安裝時使名稱間距更好。

但基本上，除了讓代碼執行您所說的包將執行的任務之外，沒有其他約定。

祝你好運！我希望你的包裹是一個打擊！

Answer 3

你不應該把所有東西都放進蟒蛇蛋裏，但無論如何，這取決於python setup.py bdist_egg選擇包含與否。但是在上傳到pypi的源代碼包中，是的，請包括setup.py無法生成的所有內容。您可以單獨上傳文檔，以便它可以發佈。

但是一般情況下，你需要需要包括在蛋中，這是雞蛋運行的必要條件。其他一切都可以包含在內，但可以通過其他方式分發，這取決於您。

只要嘗試變得聰明，有常識！