Service for querying the biocommons.uta database
Project description
uta_tools
Service for querying the UTA database
Development
Installation
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 variation/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
.
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for uta_tools-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3772ad0aad0f8230a035eb0561d46ab83692fe731b8ba4007ee8540fdc17865b |
|
MD5 | 06aae7aa99cc29d8ec1feac8308a18ad |
|
BLAKE2b-256 | a475797d4fd77759c290f28dde4cf88499511150caaae82279eef0419370c2e0 |