"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.2.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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3468a44152cdee4f866b5eae4bdd6fb3005a35a4f462e1cd83b6a792ba570150 |
|
MD5 | 8f115517d0117679fb184cee55fc8e64 |
|
BLAKE2b-256 | 6e7029d8386b74a1ac26d6c6b213c73b37b6439cdc95275f38f744b600858107 |
Hashes for ga4gh.vrsatile.pydantic-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21c3e1fe3b9f5b468ec2da35b4177a4b124799ce4f71121a65a9ad1b316d5ad4 |
|
MD5 | 97ff907f01d14f9f1b1ab6db7134d479 |
|
BLAKE2b-256 | 641da5d4574672d4dddbb9bb233897f1abede6e533b517af1b7fb6cdaec5d8d0 |