variantgrid_api
Python API client for VariantGrid Open source Variant database and analysis platform
See changelog
Install
python3 -m pip install variantgrid_api
Example
from variantgrid_api.api_client import VariantGridAPI
from variantgrid_api.data_models import EnrichmentKit
api = VariantGridAPI(server="https://variantgrid.com", api_token="YOUR_API_TOKEN")
enrichment_kit = EnrichmentKit(name="idt_haem", version=1)
result = api.create_enrichment_kit(enrichment_kit)
Annotate a VCF and download it back
Upload a VCF, have VariantGrid import + annotate any novel variants, then download the cohort-level annotated
export (all samples, single-sample VCFs included). Annotation can take a while, so the quickest way in is the
vg_api command line tool: the first call uploads, and running the same command again downloads the result
once it's ready.
$ export VARIANTGRID_API_TOKEN=YOUR_API_TOKEN
$ vg_api annotate_vcf input.vcf.gz -o results/
Uploaded input.vcf.gz (id=13256).
Annotating input.vcf.gz - run the same command again later to download.
$ vg_api annotate_vcf input.vcf.gz -o results/ # once it's done
Annotated vcf written to results/input.vcf_annotated_v254_GRCh38.vcf.gz
From Python it's upload_file() / poll_upload_status() / download_annotated(), or the blocking
annotate_vcf() one-liner. See
Annotate a VCF on the wiki for batches, the
submit-now/download-later pattern, and all the options.
Testing
# Install required testing packages
python3 -m pip install -e ".[test]"
python3 -m pytest --cov=variantgrid_api
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file variantgrid_api-1.3.2.tar.gz.
File metadata
- Download URL: variantgrid_api-1.3.2.tar.gz
- Upload date:
- Size: 21.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
85825254f9c97c9b4b245df5cac5816f1a3e94ecfb9e6f0d8c5787b0ef7250b6
|
|
| MD5 |
f9eafe2204e6dcdf1fa6f685bc5ef117
|
|
| BLAKE2b-256 |
cf964a3869682ecb24c52e70ba013b47fd90d1d5136908e0dfc8cfc8ddaa7ad2
|
File details
Details for the file variantgrid_api-1.3.2-py3-none-any.whl.
File metadata
- Download URL: variantgrid_api-1.3.2-py3-none-any.whl
- Upload date:
- Size: 15.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
29e91a8d24c496718b50011632060612ef612ba43df58d32fcaa8326df3ae197
|
|
| MD5 |
dc1d20ebc2c60a147fa36d137fb52976
|
|
| BLAKE2b-256 |
a24bfe210f2aeda3292ca26d35230116dc114af096cfa9675b5e598709d67e73
|
