從業20年的Python開發者,首次提及Python的開源項目,該如何開啓

其它

一旦你提交了這個文件並在TravisCI中激活了你的項目的,push到GitHub。一會兒後,你會看到一個基於你最近提交的編譯結束結果。如果成功了,你的編譯呈現“綠色”和並且狀態頁會顯示編譯通過。你可以看到你項目在任何時間的編譯歷史。這對對人開發特別有用,在歷史頁可以看到特定開發者出錯和編譯的頻率…

你還會收到一封通知你編譯成功的電子郵件。當然你也可以設置只有在出錯或錯誤被修復時才有郵件通知,但編譯輸出結果相同時也不會發送。這是非常有用的,你在不必被無用的“編譯通過!”郵件淹沒的同時在發生改變仍會收到警示。

用ReadTheDocs做持續文檔集成

儘管PyPI有一個官方文檔站點(pythonhosted.org),但是ReadTheDocs提供了一個更好的體驗。為什麼?ReadTheDocs有針對GitHub非常棒的集成。當你註冊ReadTheDocs的時候,你就會看到你的所有GitHub 代碼庫。選擇合適的代碼庫,做一些小幅的配置,那麼你的文檔就會在你每次提交到GitHub之後自動重新生成。

配置你的項目應該是一個很直觀的事情。只有一些事需要記住,儘管,這裡有一個配置字段的列表,對應的值可能不一定是你直接用得上的:

  • Repo: https://github.com/github_username/project_name.git
  • Default Branch:develop
  • Default Version:latest
  • Python configuration file: (leave blank)
  • Usevirtualenv: (checked)
  • Requirements file:requirements.txt
  • Documentation Type: Sphinx HTML

DRY 不要重複你自己

現在你已經完成了對於一個現存代碼基礎的所有艱難的開源工作,你可能不會想在開始一個新項目的時候把這些事重來一遍。幸運的是,你並不需要這麼做。有Andrey Roy的Cookiecutter工具(我連接到了Python版本,儘管還有一些不同語言的版本在the main repo))

Cookiecutter是一個命令行工具能夠自動執行新建項目的一些步驟來做這篇文章裡提到的一些事情。 Daniel Greenfeld (@pydanny )寫了一篇很好的關於它的博客並且提到了如何與這篇文章裡提到的實踐聯繫上。你可以從這裡看看這篇文章: Cookiecutter: Project Templates Made Easy .

結論

我們已經介紹了所有用來開源一個Python包的命令,工具和服務。當然,你可以直接把它扔到GitHub上並且說“自己安裝它”,但是沒人會這麼做。並且你僅僅是開發源代碼並不算是真正的開源軟件。

另外,你可能不會為你的項目吸引外部貢獻者。通過這裡列出的方法來設立你的項目,你就已經創建了一個容易維護的Python包並且會鼓勵大家來使用和貢獻代碼。而這,就是開源軟件的真正精神,不是嗎?

喜歡的話就轉發在下方評論留下你的見解哦!


分享到:


相關文章: