kaibu-geojson-utils

一套用于在Kaibu中处理GeoJSON注解的实用函数。

创建新仓库

• 创建一个新的仓库，并将imjoy-team/imjoy-python-template作为模板仓库。
• 克隆您的新仓库。
• 搜索并替换所有出现的kaibu-geojson-utils。将kaibu-geojson-utils替换为新仓库的名称。
• 在setup.py和requirements.txt中添加所需的包要求。
• 更新此README.md，包含对新仓库的描述和说明。

开发

• 安装并设置开发环境。

  pip install -r requirements_dev.txt
  

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

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

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

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

• 运行所有测试，检查格式和代码风格。

  tox
  

• 运行单个 tox 环境。

  tox -e lint
  

• 重新安装所有 tox 环境。

  tox -r
  

• 运行 pytest 和所有测试。

  pytest
  

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

  pytest --cov-report term-missing --cov=kaibu-geojson-utils
  

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