本文主要介绍如何打开你的Python库,有一定的参考价值。有兴趣的朋友可以参考一下。希望大家看完这篇文章后收获多多。让边肖带你去了解一下。
00-1010把代码放在GitHub上,那里有很多开源项目,人们很容易提交拉取请求。
1、源码
选择一个开源许可证。总的来说,麻省理工的许可是一个很好的宽容许可。如果您有具体要求,Creative Common的选择许可可以指导您完成其他选择。最重要的是,选择许可证时要记住三条规则:
不要创建自己的许可证。
不要创建自己的许可证。
不要创建自己的许可证。
00-1010将一个名为README.rst(用ReStructured Text格式化)的文件放在项目树的顶部。
GitHub将像Markdown一样呈现重构的文本,而ReST将在Python的文档生态系统中表现得更好。
00-1010写测试。对你没用。但是对于想写补丁的人来说,避免破坏相关功能是非常有用的。
测试可以帮助协作者进行协作。
通常,如果你能用pytest运行它,它将是* * *。还有其他测试工具mdashmdash但是使用它们的理由很少。
00-1010使用短绒制作样式:皮纹、片状8或带格子的黑色。除非您使用Black,否则请确保在文件中指定配置选项,并将它们签入版本控制系统。
00-1010文档字符串用于记录模块、函数、类和方法。
您可以使用几种样式。我更喜欢谷歌文档字符串,但ReST文档字符串也是一个选项。
Sphinx可以同时处理Google风格和ReST的文档字符串,从而将零散的文档整合到API文档中。
2、许可证
使用狮身人面像。(阅读我们的文章。教程非常有用,但是指出它是什么、它的优点和缺点以及任何特殊注意事项也同样重要。
3、README
使用tox或nox自动运行测试和linter,并构建文档。这些工具支持“依赖矩阵”。这些矩阵往往增长很快,但是您可以尝试根据合理的示例进行测试,例如Python版本、依赖版本和可能安装的可选依赖。
00-1010使用setuptools。写一个setup.py和一个setup.cfg.如果同时支持Python 2和Python 3,请在setup.cfg中以通用格式指定滚轮
tox或nox应该做的事情之一是制造一个车轮并测试安装的车轮。
避免使用c扩展。如果出于性能或绑定原因需要,请将它们放在单独的包装中。正确打包C扩展可以写一篇新文章。这里有很多问题!
4、测试
使用公共持久性工具。TravisCI和CircleCI为开源项目提供免费包。如果GitHub或其他存储库被配置为在合并拉请求之前通过检查,那么您不必担心在代码审查期间告诉用户修复测试或样式。
00-1010使用了SemVer或CalVer。有很多工具可以帮助你管理版本:增量、bumpversion和setuptools_scm都是PyPI上的包,可以帮助你管理版本。
00-1010通过运行tox或nox并使用twine将文件上传到PyPI。你可以在DevPI中“测试上传”。
感谢您仔细阅读本文。希望边肖分享的文章《如何打开你的Python库》对大家有所帮助。也希望大家多多支持和关注行业信息渠道,更多相关知识等着你去学习!
内容来源网络,如有侵权,联系删除,本文地址:https://www.230890.com/zhan/50276.html