ga4gh.vrsatile.pydantic 0.1.0.dev7

"Translation of the GA4GH VRS and VRSATILE Schemas to a Pydantic data model"

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:

• 0.0.X ~ 1.2.X: ga4gh.vrsatile.pydantic 0.0.X tracks VRS 1.2.X and the VRSATILE latest
• 0.1.X ~ metaschema-updates: ga4gh.vrsatile.pydantic 0.1.X tracks VRS and VRSATILE metaschema-updates

Developer instructions

To install vrstaile-pydantic:

pip install ga4gh.vrsatile.pydantic

Following are sections include instructions specifically for developers.

For a development install, we recommend using Pipenv. See the pipenv docs for direction on installing pipenv in your compute environment.

Once installed, from the project root dir, just run:

pipenv lock
pipenv sync

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