"Translation of the GA4GH VRS and VRSATILE Schemas to a Pydantic data model"
Project description
vrsatile-pydantic
Translation of the GA4GH VRS and VRSATILE schemas to a Pydantic data model
The ga4gh/vrsatile/pydantic repo depends on VRS and VRSATILE models, and therefore each ga4gh.vrsatile.pydantic package on PyPI uses a particular version of VRS and VRSATILE. The correspondences between the packages may be summarized as:
ga4gh.vrsatile.pydantic branch | ga4gh.vrsatile.pydantic version | VRS version | VRSATILE version |
---|---|---|---|
main | 0.0.X | 1.X.X | main |
metaschema-update | 0.1.X | metaschema-update | metaschema-update |
Installation
vrsatile-pydantic is available via PyPI:
pip install ga4gh.vrsatile.pydantic
Developer Instructions
Following are sections include instructions specifically for developers.
Installation
For a development install, we recommend using Pipenv. See the pipenv docs for direction on installing pipenv in your compute environment.
Once installed, clone the repo and initialize the environment:
git clone https://github.com/ga4gh/vrsatile-pydantic
cd vrsatile-pydantic
pipenv shell
pipenv update
pipenv install --dev
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
Running unit tests
Running unit tests is as easy as pytest.
pipenv run pytest tests
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 ga4gh.vrsatile.pydantic-0.0.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44c5ad2008c9cf6c624d116234e02ffbf2cdbd82b3fa25856af10f02e0ac6a49 |
|
MD5 | 4bdd1e0e859505a2e4aa1e2e7b5b0937 |
|
BLAKE2b-256 | ecb2fc7e0aee33dfe25ee5f4287f0f001134cf5d2a75b9e389a865384caf7643 |
Hashes for ga4gh.vrsatile.pydantic-0.0.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1535a91ca8dc2fc5c05978b9dfa5cd426c98aa27c5e3daf5e9a177f17aa2774d |
|
MD5 | e314ed09e99997f6ce5c518b0a026fc2 |
|
BLAKE2b-256 | 712cbe702becc3701edae65df640c8d73917c1cab86c80e8334d588ce704463e |