这篇文章主要介绍了怎么开源你的Python库,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获、下面让小编带着大家一起了解一下。
1,源码
将代码放在GitHub上,这里有很多开源项目,并且人们很容易提交拉取请求。
2,许可证
选择一个开源许可证。一般来说麻省理工学院许可证是一个挺好的宽容许可证。如果你有特定要求,创造性的常见的选择许可证可以指导你完成其它选择。最重要的是,在选择许可证时要记住三条规则:
不要创建自己的许可证。
<李>不要创建自己的许可证。
<李>不要创建自己的许可证。
3,自述
将一个名为<代码> README。rst>
GitHub将像减价一样渲染重组文本,而其他在Python的文档生态系统中的表现更好。
4,测试
写测试。这对你来说没有用处。但对于想要编写避免破坏相关功能的补丁的人来说,它非常有用。
测试可帮助协作者进行协作。
通常情况下,如果可以用pytest运行就* * *了。还有其他测试工具,终止,和终止,但很少有理由去使用它们。
5样式
使用短绒制定样式:PyLint, Flake8或者带上<代码>,>
6, API文档
使用文档字符串来记录模块,函数、类和方法。
你可以使用几种样式。我更喜欢谷歌风格的文档字符串,但其他文档字符串也是一种选择。
斯芬克斯可以同时处理谷歌风格和其他的文档字符串,以将零散的文档集成为API文档。
7零散文档
使用斯芬克斯。(阅读我们这篇文章)教程很有用,但同样重要的是要指明这是什么,它有什么好处,它有什么坏处,以及任何特殊的考虑因素。
8,构建
使用托克斯或氮氧化物自动运行测试和短绒,并构建文档。这些工具支持“依赖矩阵”。这些矩阵往往会快速增长,但你可以尝试针对合理的样本进行测试,例如Python版本,依赖项版本以及可能安装的可选依赖项。
9日打包
使用setuptools工具。写一个<代码>设置。py> 设置。cfg> 设置。cfg>
托克斯或氮氧化物应该做的一件事是构建轮并对已安装的轮进行测试。
避免使用C扩展。如果出于性能或绑定的原因一定需要它们,请将它们放在单独的包中。正确打包C扩展可以写一篇新的文章。这里有很多问题!
10,持续集成
使用公共持续工具.TravisCI和CircleCI为开源项目提供免费套餐。将GitHub或其他仓库配置为在合并拉请求之前需要先通过检查,那么你就不必担心在代码评审中告知用户修复测试或样式。
11日版本
使用SemVer或弗。有许多工具可以帮助你管理版本:增量,bumpversion和setuptools_scm等都是PyPI上的包,都可以帮助你管理版本。
12日发布
通过运行托克斯或氮氧化物并使用细绳将文件上传到PyPI上发布。你可以通过在DevPI中“测试上传”。
感谢你能够认真阅读完这篇文章,希望小编分享的“怎么开源你的Python库”这篇文章对大家有帮助,同时也希望大家多多支持,关注行业资讯频道,更多相关知识等着你来学习!
