"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 |
---|---|---|---|
vrs-1.2 (no longer being updated) | 0.0.X | 1.2.X | main |
metaschema-update | 0.1.X | metaschema-update | metaschema-update |
main | 0.2.X | 1.3.X | main |
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.1.0.dev9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3080675d9eb1474ff4fff9929a82813cfb531604d915f628547c874eb4b39661 |
|
MD5 | 6214f1732933ec43d4f2e71199dbb842 |
|
BLAKE2b-256 | cf4d128d243f44e654da52215a9d42ca3fb56c1ef517cc79f61461f730b46f22 |
Hashes for ga4gh.vrsatile.pydantic-0.1.0.dev9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9e6bc3ecf247d84b0a8af2a4ea26351ac303e5dd275d11c95f91a58cfbbe922 |
|
MD5 | a74ea7c6e49b27245b084d1c1cf9a151 |
|
BLAKE2b-256 | 323fa040ac634bda4e2fe7bd3909018b606d7672ebf899a8490abdc6240eba07 |