virtool

virtool

virtool是一个基于网络的应用程序，用于使用高通量测序诊断病原体感染。

网站：https://www.virtool.ca

入门

请参阅virtool文档以开始使用最新版本的virtool 4.0.0。

关于版本

virtool目前正在经历向云原生应用程序的重大转变。这意味着virtool可以跨多个主机扩展工作，并在 Kubernetes 和公共云提供商中本地运行。

对于当前用户和管理员：

1. 目前应该使用virtool 4.0.0系列。
2. 在可预见的将来， virtool 4.0.0 系列将继续收到错误和安全修复。
3. virtool 5.0.0 将包含多个需要一起运行的容器化服务。将提供部署和迁移指南。

测试

在源目录根目录中：

1. 在 Docker 中启动所需的支持服务。

    docker compose -f tests/docker-compose.yml -p virtool -test up -d
   

2. 运行测试套件：

    poetry run pytest
   

多路复用

该测试套件与pytest-xdist一起使用。

 poetry run pytest -n 4

这将使用多个 Python 进程并行运行测试。

快照

我们使用 Syrupy 进行快照测试。

快照用于我们想要断言对象（例如数据库记录、Pydantic 对象、API 响应）具有预期形状和值集的测试。

如果需要更新快照：

 poetry run pytest <path_to_test_file> --su

您可以通过指定测试类或函数来更加具体：

 poetry run pytest <path_to_test_file>::<class_or_function>

始终明确您要更新的快照。不要为了让测试通过而盲目地更新大量快照文件。

提交

所有提交必须遵循常规提交规范。

这些标准化提交消息用于在提交从成功的 PR 合并到main后使用semantic-release自动发布版本。

例子

 feat: add API support for assigning labels to existing samples

必要时需要描述性正文和页脚来描述提交的影响。在适当的地方使用子弹。

附加要求

1. 写成祈使句。例如， “修复错误” ，而不是“已修复错误”或“修复错误” 。
2. 不要提及问题或代码审查。例如，不要写这样的内容： “在审阅中请求进行样式更改” 。相反， “更新样式以提高可访问性” 。
3. 提交不是您的个人日记。例如，不要写这样的内容： “让服务器再次运行”或“哎呀。修复了我的代码味道” 。

来自 Tim Pope：关于 Git 提交消息的注释