从业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包并且会鼓励大家来使用和贡献代码。而这,就是开源软件的真正精神,不是吗?

喜欢的话就转发在下方评论留下你的见解哦!


分享到:


相關文章: