uta-tools

查询UTA数据库的服务

安装

pip

pip install uta-tools

开发

克隆存储库

git clone https://github.com/cancervariants/uta-tools
cd uta_tools

如果需要，安装Pipenv。

安装后端依赖并进入Pipenv环境

pipenv shell
pipenv lock && pipenv sync
pipenv install --dev

UTA数据库安装

uta-tools使用本地安装的UTA数据库。有关其他安装方法，请访问biocommons.uta。

本地安装

以下命令可能需要根据安装环境进行修改。

1. 安装PostgreSQL

2. 创建用户和数据库。

   $ createuser -U postgres uta_admin
   $ createuser -U postgres anonymous
   $ createdb -U postgres -O uta_admin uta
   

3. 从uta_tools/data目录安装本地

export UTA_VERSION=uta_20210129.pgd.gz
curl -O http://dl.biocommons.org/uta/$UTA_VERSION
gzip -cdq ${UTA_VERSION} | grep -v "^REFRESH MATERIALIZED VIEW" | psql -h localhost -U uta_admin --echo-errors --single-transaction -v ON_ERROR_STOP=1 -d uta -p 5433

UTA安装问题

如果您在安装UTA时遇到问题，可以访问这两个README。

连接到数据库

要连接到UTA数据库，您可以使用默认的URL（postgresql://uta_admin@localhost:5433/uta/uta_20210129）。如果您使用默认URL，则必须设置密码，使用环境变量UTA_PASSWORD或在UTA类中设置参数db_pwd。

如果您不想使用默认值，则必须设置环境变量UTA_DB_URL，其格式为driver://user:pass@host:port/database/schema。

数据下载

SeqRepo

uta-tools依赖于seqrepo，您必须自行下载。

从根目录

pip install seqrepo
sudo mkdir /usr/local/share/seqrepo
sudo chown $USER /usr/local/share/seqrepo
seqrepo pull -i 2021-01-29  # Replace with latest version using `seqrepo list-remote-instances` if outdated

如果您遇到如下类似的错误

PermissionError: [Error 13] Permission denied: '/usr/local/share/seqrepo/2021-01-29._fkuefgd' -> '/usr/local/share/seqrepo/2021-01-29'

您需要进行以下操作
（可能不是._fkuefgd，请替换为您的错误信息路径）

sudo mv /usr/local/share/seqrepo/2021-01-29._fkuefgd /usr/local/share/seqrepo/2021-01-29
exit

transcript_mappings.tsv

uta-tools使用Ensembl BioMart检索uta_tools/data/transcript_mappings.tsv。我们目前使用的数据集是Human Genes (GRCh38.p13)，我们使用的以下属性是：基因稳定ID、基因稳定ID版本、转录本稳定ID、转录本稳定ID版本、蛋白质稳定ID、蛋白质稳定ID版本、RefSeq匹配转录本（MANE Select）、基因名称。

LRG_RefSeqGene

uta-tools获取LRG_RefSeqGene的最新版本。此文件可在此处找到。

MANE Summary Data

uta-tools获取MANE.GRCh38.*.summary.txt.gz的最新版本。此文件可在此处找到。

在本地启动UTA工具服务

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

uvicorn uta_tools.main:app --reload

接下来，在您的本地计算机上查看FastAPI：http://127.0.0.1:8000/uta_tools

初始化编码风格测试

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

我们使用pre-commit运行一致性测试。

这确保了

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

在第一次提交前运行

pre-commit install

测试

从存储库的根目录

pytest