ImJoy Utils

Python中ImJoy的实用模块

开发

• 安装并设置开发环境。

  pip install -r requirements_dev.txt
  

  这将安装所有依赖项。它还将以开发模式安装此包，因此代码更改将立即应用，无需重新安装。

• 以下是我们在开发中使用的一些开发工具列表。

  • black
  • flake8
  • mypy
  • pydocstyle
  • pylint
  • pytest
  • tox

• 建议在您的代码编辑器中也使用相应的代码格式化和检查工具，以获得即时反馈。一个可以做到这一点的流行编辑器是vscode。

• 运行所有测试，检查格式化和检查。

  tox
  

• 运行单个tox环境。

  tox -e lint
  

• 重新安装所有tox环境。

  tox -r
  

• 运行pytest及其所有测试。

  pytest
  

• 运行pytest并为包计算覆盖率。

  pytest --cov-report term-missing --cov=imjoy_utils
  

• 默认支持通过GitHub actions进行持续集成。GitHub actions对公共仓库是免费的，并且为私有仓库每月提供2000分钟的免费Ubuntu构建时间。