"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.dev8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9111b57e41368362164d50224d823fadbded5522d593e511899fe431ea379e1d |
|
MD5 | 0bab74270569e5b62ca9a07c79ff727b |
|
BLAKE2b-256 | 5b5b86699fc9416c0a4e5aca414abdc6c95b0e6fefbae69129dc5ef83a6e45c9 |
Hashes for ga4gh.vrsatile.pydantic-0.1.0.dev8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b73a92c7c015a5464bd25bd8fe6a102f3755c9d369b80c42feecb27935c7d7a |
|
MD5 | 32d208b295f53aa11bf472268ef36986 |
|
BLAKE2b-256 | bb754eb1043afd20dc746d9f74e909cd1e8c9964110435618c688c8640f4bf2d |