证据归一化

归一化证据的服务

开发者指南

以下部分包含专门针对开发者的说明。

安装

Pipenv

对于开发安装，我们建议使用Pipenv。有关在您的计算环境中安装pipenv的说明，请参阅pipenv文档。

安装后，从项目根目录运行

pipenv shell
pipenv lock && pipenv sync

Pip

如果您希望安装evidence.dev的开发者依赖项

pip install evidence-normalizer[dev]

如果您不需要额外的依赖项

pip install evidence-normalizer

后端服务

证据标准化依赖于变异标准化来标准化癌症热点数据。您需要设置后端服务和设置适当的环境变量。有关更多信息，请参阅README。

本地启动证据标准化服务

要启动服务，请运行以下命令：

uvicorn evidence.main:app --reload

接下来，在您的本地机器上查看OpenAPI文档：http://127.0.0.1:8000/evidence

初始化编码风格测试

编码风格由flake8管理，并在提交之前进行检查。

我们使用pre-commit来运行合规性测试。

这确保了：

• 检查代码风格
• 检查添加的大型文件
• 检测AWS凭证
• 检测私钥

在第一次提交前运行

pre-commit install

运行单元测试

运行单元测试就像pytest一样简单。

pipenv run pytest