This project has been archived by its maintainers, and is no longer receiving any updates.
uta_tools
Service for querying the UTA database
Installation
pip
pip install uta_tools
Development
Clone the repo:
git clone https://github.com/cancervariants/uta_tools
cd uta_tools
Install Pipenv if necessary.
Install backend dependencies and enter Pipenv environment:
pipenv shell
pipenv lock && pipenv sync
UTA Database Installation
uta_tools uses intalls local UTA database. For other ways to install, visit biocommons.uta.
Local Installation
The following commands will likely need modification appropriate for the installation environment.
-
Install PostgreSQL
-
Create user and database.
$ createuser -U postgres uta_admin $ createuser -U postgres anonymous $ createdb -U postgres -O uta_admin uta -
To install locally, from the uta_tools/data directory:
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
Connecting to the database
To connect to the UTA database, you can use the default url (postgresql://uta_admin@localhost:5433/uta/uta_20210129). If you use the default url, you must either set the password using environment variable UTA_PASSWORD or setting the parameter db_pwd in the UTA class.
If you do not wish to use the default, you must set the environment variable UTA_DB_URL which has the format of driver://user:pass@host/database/schema.
Data Downloads
SeqRepo
uta_tools relies on seqrepo, which you must download yourself.
From the root directory:
cd uta_tools
pip install seqrepo
mkdir -p data/seqrepo
seqrepo -r data/seqrepo pull -i 2021-01-29
sudo chmod -R u+w data/seqrepo
cd data/seqrepo
seqrepo_date_dir=$(ls -d */)
sudo mv $seqrepo_date_dir latest
transcript_mappings.tsv
uta_tools uses Ensembl BioMart to retrieve uta_tools/data/transcript_mappings.tsv. We currently use Human Genes (GRCh38.p13) for the dataset and the following attributes we use are: Gene stable ID, Gene stable ID version, Transcript stable ID, Transcript stable ID version, Protein stable ID, Protein stable ID version, RefSeq match transcript (MANE Select), Gene name.
LRG_RefSeqGene
uta_tools fetches the latest version of LRG_RefSeqGene. This file is found can be found here.
MANE Summary Data
uta_tools fetches the latest version of MANE.GRCh38.*.summary.txt.gz. This file is found can be found here.
Init coding style tests
Code style is managed by flake8 and checked prior to commit.
We use pre-commit to run conformance tests.
This ensures:
- Check code style
- Check for added large files
- Detect AWS Credentials
- Detect Private Key
Before first commit run:
pre-commit install
Testing
From the root directory of the repository:
pytest
Metadata
Release files for uta-tools 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| uta_tools-0.0.2.tar.gz | 21.8 kB | Without provenance | Details for uta_tools-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| uta_tools-0.0.2-py3-none-any.whl | Python 3 | none | any | Details for uta_tools-0.0.2-py3-none-any.whl |
Total release size: 4.0 MB
Release files / uta_tools-0.0.2.tar.gz
| Download URL | uta_tools-0.0.2.tar.gz |
|---|---|
| Size | 21.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
59b58b69e664d99577b443f8e6810d49f21f4f142c371197a865f6239510a6e5
|
|
BLAKE2b-256 checksum How to use checksums |
3c10d1571ea25848678620695fc25125087b0ec51e8b3bc5098bb0828080ed5c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
|
Release files / uta_tools-0.0.2-py3-none-any.whl
| Download URL | uta_tools-0.0.2-py3-none-any.whl |
|---|---|
| Size | 4.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c8f16faac0e6b0f4aa7f9ebfe8e486f32a6557ebfeb7df5bf422cab9fecee0b7
|
|
BLAKE2b-256 checksum How to use checksums |
984e36c84d46a8740e56c1ba3b6ace5241faefc08318f946e2e8460fbaf3461e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
|
Security for uta-tools 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.