This project has been archived by its maintainers, and is no longer receiving any updates.
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
Metadata
Release files for ga4gh.vrsatile.pydantic 0.0.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ga4gh.vrsatile.pydantic-0.0.12.tar.gz | 13.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ga4gh.vrsatile.pydantic-0.0.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 26.7 kB
Release files / ga4gh.vrsatile.pydantic-0.0.12.tar.gz
| Download URL | ga4gh.vrsatile.pydantic-0.0.12.tar.gz |
|---|---|
| Size | 13.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
44c5ad2008c9cf6c624d116234e02ffbf2cdbd82b3fa25856af10f02e0ac6a49
|
|
BLAKE2b-256 checksum How to use checksums |
ecb2fc7e0aee33dfe25ee5f4287f0f001134cf5d2a75b9e389a865384caf7643
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Release files / ga4gh.vrsatile.pydantic-0.0.12-py3-none-any.whl
| Download URL | ga4gh.vrsatile.pydantic-0.0.12-py3-none-any.whl |
|---|---|
| Size | 13.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1535a91ca8dc2fc5c05978b9dfa5cd426c98aa27c5e3daf5e9a177f17aa2774d
|
|
BLAKE2b-256 checksum How to use checksums |
712cbe702becc3701edae65df640c8d73917c1cab86c80e8334d588ce704463e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|