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 |
|---|---|---|---|
| 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
3 maintainers
Metadata
3 maintainers
Release files for ga4gh.vrsatile.pydantic 0.1.0.dev8
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.1.0.dev8.tar.gz | 12.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ga4gh.vrsatile.pydantic-0.1.0.dev8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.7 kB
Release files / ga4gh.vrsatile.pydantic-0.1.0.dev8.tar.gz
| Download URL | ga4gh.vrsatile.pydantic-0.1.0.dev8.tar.gz |
|---|---|
| Size | 12.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9111b57e41368362164d50224d823fadbded5522d593e511899fe431ea379e1d
|
|
BLAKE2b-256 checksum How to use checksums |
5b5b86699fc9416c0a4e5aca414abdc6c95b0e6fefbae69129dc5ef83a6e45c9
|
| 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.1.0.dev8-py3-none-any.whl
| Download URL | ga4gh.vrsatile.pydantic-0.1.0.dev8-py3-none-any.whl |
|---|---|
| Size | 12.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9b73a92c7c015a5464bd25bd8fe6a102f3755c9d369b80c42feecb27935c7d7a
|
|
BLAKE2b-256 checksum How to use checksums |
bb754eb1043afd20dc746d9f74e909cd1e8c9964110435618c688c8640f4bf2d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
