怎么开源你的Python库

技术怎么开源你的Python库这篇文章主要介绍了怎么开源你的Python库,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。1、源码将代码放在 GitHub

本文主要介绍如何打开你的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

(0)

相关推荐

  • mybatis-plus无法通过logback-spring输出怎么办

    技术mybatis-plus无法通过logback-spring输出怎么办小编给大家分享一下mybatis-plus无法通过logback-spring输出怎么办,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探

    攻略 2021年11月13日
  • 如何进行C#打印设置实现源码的分析

    技术如何进行C#打印设置实现源码的分析本篇文章为大家展示了如何进行C#打印设置实现源码的分析,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。C#打印设置是如何在实际编程开发中体现的

    攻略 2021年11月24日
  • CentOS7环境中DHCP怎么配置

    技术CentOS7环境中DHCP怎么配置这篇文章主要讲解了“CentOS7环境中DHCP怎么配置”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“CentOS7环境中DHCP

    攻略 2021年11月29日
  • css如何做直角梯形

    技术css如何做直角梯形本篇内容主要讲解“css如何做直角梯形”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“css如何做直角梯形”吧! 在css中

    攻略 2021年12月4日
  • 配置ssh时本地验证失败怎么办(ssh提示密钥问题)

    技术SCP未验证主机密钥错误怎么解决本篇文章给大家分享的是有关SCP未验证主机密钥错误怎么解决,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。最近在研究ope

    攻略 2021年12月23日
  • Docker Compose怎么搭建 Redis Cluster集群环境

    技术Docker Compose怎么搭建 Redis Cluster集群环境Docker Compose怎么搭建 Redis Cluster集群环境,相信很多没有经验的人对此束手无策,为此本文总结了问题出现的原因和解决方

    攻略 2021年12月10日