Lexselon与Batlab v1.0电池测试系统通信的低级库
batlab的Python项目详细描述
batlab-software-python是一个python库和示例命令行脚本,用于通过usb与batlabs池进行交互。这个工具是专为那些希望将batlab硬件集成到自己的单元测试工作流或环境中的爱好者和更高级的用户设计的。
要求
此模块支持python>;=3.4。
不支持Python2。
安装
要安装最新版本,可以使用pip:
$ pip install batlab
要升级,您可以运行以下任一操作:
$ pip install batlab --upgrade $ pip install batlab -U
文档
此库的文档位于Read the Docs。请访问此处以查找此自述文件以及此库中类和方法的可用文档。
用法
库可以导入到您自己的程序中,也可以使用提供的示例batlab实用程序脚本。
Batlab实用脚本
batlab实用程序脚本允许用户通过简单的命令行界面与连接的batlab单元池执行基本交互。
要运行脚本,请确保安装了batlab包,然后运行:
$ batlabutil
键入help以显示脚本中的命令列表以及如何使用这些命令。脚本的目的是作为一个例子,供用户使用batlab库编写自己的电池测试软件。
贡献
向此存储库投稿时,请首先与此存储库的所有者讨论您希望通过问题、电子邮件或任何其他方法进行的更改。
git分支模型
我们遵循here描述的开发模型。master分支中的任何内容都被视为生产。大多数工作发生在develop分支中,或者在合并到master之前合并到develop中的功能分支中。
记录
请根据Google Python Style Guide standards使用文档字符串记录代码(特别是函数和类)。这将确保您的笔记被自动提取并包含在生成的文档中。
运行测试
要运行单元测试,请从根目录运行:
$ python setup.py test
部署
此库部署到PyPi。每次推送提交都会使用Travis CI生成生成。当一个新的标记被推入或合并到master中时,该构建将通过pypi自动部署到最终用户。
若要发布新版本,工作流可能如下所示。首先进行更改:
$ git commit -am "some changes to the develop branch"
然后,使用新版本号更新setup.py和docs/source/conf.py(在本例中,我们将使用示例0.100.56)。使用这些更改进行提交并将其推送到github:
$ git commit -am "rev version number to 0.100.56"
$ git push origin develop
然后你必须等几分钟,以确保建立通过特拉维斯。如果生成失败,则无法将提交合并到master。一旦构建通过,就可以合并到master中,创建一个带标记的发布并推送。合并时,使用--no-ff保留提交和分支历史:
$ git checkout master $ git merge --no-ff develop $ git tag v0.100.56 $ git push origin master $ git push --tags
更改应该自动展开到pypi,代码中包含的任何文档都将自动展开以读取文档。
许可证
此库在lgpl-3.0下获得许可-有关详细信息,请参见LICENSE。