"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.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d2c2b10fb14a46edb419eed16a12c790a6d2095ff45cc10954709b56bb7e3dc |
|
MD5 | 1d4d7c169ccd81d347503fa5a6b32463 |
|
BLAKE2b-256 | b8dfdac62a489af93727305e98d3073c171855f6a550c1e926cbefd6f349f371 |
Hashes for ga4gh.vrsatile.pydantic-0.0.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8fa62460eb92474331758e97204d821f5a6b67a70f408376fce1ce81406f0a4 |
|
MD5 | 7c34527d88196db177cbf1c3b5d07c7d |
|
BLAKE2b-256 | 2e7d66079048c06912d68f28c044835c06bc9caa52046d5cfdfee912657b736e |