# vrsatile-pydantic
Translation of the GA4GH [VRS](https://vrs.ga4gh.org/en/stable/) and [VRSATILE](https://vrsatile.readthedocs.io/en/latest/) 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](https://github.com/ga4gh/vrs) | [main](https://github.com/ga4gh/vrsatile/tree/main) |
| metaschema-update | 0.1.X | [metaschema-update](https://github.com/ga4gh/vrs/tree/metaschema-update) | [metaschema-update](https://github.com/ga4gh/vrsatile/tree/metaschema-update) |
## Installation
vrsatile-pydantic is available via PyPI:
```commandline
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](https://pipenv-fork.readthedocs.io/en/latest/#install-pipenv-today)
for direction on installing pipenv in your compute environment.
Once installed, clone the repo and initialize the environment:
```commandline
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](https://github.com/PyCQA/flake8) and checked prior to commit.
We use [pre-commit](https://pre-commit.com/#usage) to run conformance tests.
This ensures:
* Check code style
* Check for added large files
* Detect AWS Credentials
* Detect Private Key
Before first commit run:
```commandline
pre-commit install
```
### Running unit tests
Running unit tests is as easy as pytest.
```commandline
pipenv run pytest tests
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ga4gh/vrs-pydantic",
"name": "ga4gh.vrsatile.pydantic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "bioinformatics,ga4gh,genomics,hgvs,spdi,variation",
"author": "Alex H. Wagner",
"author_email": "alex.wagner@nationwidechildrens.org",
"download_url": "https://files.pythonhosted.org/packages/b8/df/dac62a489af93727305e98d3073c171855f6a550c1e926cbefd6f349f371/ga4gh.vrsatile.pydantic-0.0.13.tar.gz",
"platform": null,
"description": "# vrsatile-pydantic\nTranslation of the GA4GH [VRS](https://vrs.ga4gh.org/en/stable/) and [VRSATILE](https://vrsatile.readthedocs.io/en/latest/) schemas to a Pydantic data model\n\nThe 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:\n\n| ga4gh.vrsatile.pydantic branch | ga4gh.vrsatile.pydantic version | VRS version | VRSATILE version |\n| ---- | --- | --- | --- |\n| main | 0.0.X | [1.X.X](https://github.com/ga4gh/vrs) | [main](https://github.com/ga4gh/vrsatile/tree/main) |\n| metaschema-update | 0.1.X | [metaschema-update](https://github.com/ga4gh/vrs/tree/metaschema-update) | [metaschema-update](https://github.com/ga4gh/vrsatile/tree/metaschema-update) |\n\n\n## Installation\n\nvrsatile-pydantic is available via PyPI:\n```commandline\npip install ga4gh.vrsatile.pydantic\n```\n\n## Developer Instructions\n\nFollowing are sections include instructions specifically for developers.\n\n### Installation\n\nFor a development install, we recommend using Pipenv. See the\n[pipenv docs](https://pipenv-fork.readthedocs.io/en/latest/#install-pipenv-today)\nfor direction on installing pipenv in your compute environment.\n\nOnce installed, clone the repo and initialize the environment:\n\n```commandline\ngit clone https://github.com/ga4gh/vrsatile-pydantic\ncd vrsatile-pydantic\npipenv shell\npipenv update\npipenv install --dev\n```\n\n### Init coding style tests\n\nCode style is managed by [flake8](https://github.com/PyCQA/flake8) and checked prior to commit.\n\nWe use [pre-commit](https://pre-commit.com/#usage) to run conformance tests.\n\nThis ensures:\n\n* Check code style\n* Check for added large files\n* Detect AWS Credentials\n* Detect Private Key\n\nBefore first commit run:\n\n```commandline\npre-commit install\n```\n\n### Running unit tests\n\nRunning unit tests is as easy as pytest.\n\n```commandline\npipenv run pytest tests\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "\"Translation of the GA4GH VRS and VRSATILE Schemas to a Pydantic data model\"",
"version": "0.0.13",
"project_urls": {
"Homepage": "https://github.com/ga4gh/vrs-pydantic"
},
"split_keywords": [
"bioinformatics",
"ga4gh",
"genomics",
"hgvs",
"spdi",
"variation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e7d66079048c06912d68f28c044835c06bc9caa52046d5cfdfee912657b736e",
"md5": "7c34527d88196db177cbf1c3b5d07c7d",
"sha256": "f8fa62460eb92474331758e97204d821f5a6b67a70f408376fce1ce81406f0a4"
},
"downloads": -1,
"filename": "ga4gh.vrsatile.pydantic-0.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c34527d88196db177cbf1c3b5d07c7d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13397,
"upload_time": "2023-06-27T18:03:17",
"upload_time_iso_8601": "2023-06-27T18:03:17.544141Z",
"url": "https://files.pythonhosted.org/packages/2e/7d/66079048c06912d68f28c044835c06bc9caa52046d5cfdfee912657b736e/ga4gh.vrsatile.pydantic-0.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8dfdac62a489af93727305e98d3073c171855f6a550c1e926cbefd6f349f371",
"md5": "1d4d7c169ccd81d347503fa5a6b32463",
"sha256": "7d2c2b10fb14a46edb419eed16a12c790a6d2095ff45cc10954709b56bb7e3dc"
},
"downloads": -1,
"filename": "ga4gh.vrsatile.pydantic-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "1d4d7c169ccd81d347503fa5a6b32463",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13360,
"upload_time": "2023-06-27T18:03:18",
"upload_time_iso_8601": "2023-06-27T18:03:18.972436Z",
"url": "https://files.pythonhosted.org/packages/b8/df/dac62a489af93727305e98d3073c171855f6a550c1e926cbefd6f349f371/ga4gh.vrsatile.pydantic-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 18:03:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ga4gh",
"github_project": "vrs-pydantic",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ga4gh.vrsatile.pydantic"
}
JSON
