语言, 成果公开

Python开源项目Guan

在使用其他的软件包时,往往会遇到包装过度、调用接口少、文档复杂等问题。这里把自己常用的一些函数打包成package上传至PyPI,方便后续的调用。函数和版本会根据需求不定期更新。

Guan官方地址:https://py.guanjihuan.com

安装或更新命令:pip install --upgrade guan

使用方法:import guan

项目说明:

  1. 该项目最初的目的是方便自己的调用,在使用相同功能函数时不需要复制到新的py文件中,直接使用"import guan"。其他人如果觉得某些函数有用,也可安装使用。此外,如果觉得某些函数不能完全达到自己的要求,可复制函数源码自行修改。同时也可邮件反馈,在后续版本更新中会修改或者补充。
  2. 不包装成类(class),全部以函数的形式实现功能,使用时无需查询某个函数归为哪个类,方便直接调用。不额外增加繁杂的说明文档,使用者根据需求选用函数,有必要时需要自行阅读源码。在函数中会尽量避免对各种情况的判断,只实现某种单一功能,同时变量名也尽量会通俗化,方便源码的阅读,同时免去了一些不必要的备注,所以不必担心有难度。
  3. 除了阅读教程,建议在使用前大概浏览下源码,了解函数具体的输入输出格式。不建议生搬硬套,不然容易出现错误。注意随着版本的更新,函数名字可能会发生改变。如果遇到函数无法使用,需改为最新版本所对应的名字。

其他开源项目:凝聚态物理中的一些开源软件包

项目上传方法:PyPi上传流程

我的项目版本管理步骤:

  1. 通过命令将最新版本上传至PyPi。
  2. 本地pip install --upgrade guan更新。
  3. 修改官方网站上的版本信息。
  4. 修改API Reference文件。
  5. 同步Github。
  6. 同步Cloud。
865 次浏览

【说明:本站主要是个人的一些笔记和代码分享,内容可能会不定期修改。为了使全网显示的始终是最新版本,这里的文章未经同意请勿转载。引用请注明出处:https://www.guanjihuan.com

评论说明:
(1)在保留浏览器缓存的前提下,目前支持72小时自主修改或删除个人评论。如果自己无法修改或删除评论,可再次评论或联系我。如有发现广告留言,请勿点击链接,博主会不定期删除。
(2)评论支持Latex公式。把latexpage作为标签放在任何位置,评论中的公式可正常编译,示例:
$Latex formula$  [latexpage]

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注