va-spec-python

VA-Spec-Python provides Python language support and a reference implementation for the GA4GH Variant Annotation Specification (VA-Spec).

Information

license

Releases

gitHub tag pypi DOI

Development

action status issues GitHub Open Pull Requests GitHub license GitHub stars GitHub forks

Features

  • Pydantic implementation of VA-Spec models

Known Issues

You are encouraged to browse issues. All known issues are listed there. Please report any issues you find.

Developers

This section is intended for developers who contribute to VA-Spec-Python.

Installing for development

Prerequisites

  • Python >= 3.10
    • Note: Python 3.12 is required for developers contributing to VA-Spec-Python

Fork the repo at https://github.com/ga4gh/va-spec-python/.

Install development dependencies and pre-commit:

git clone --recurse-submodules git@github.com:YOUR_GITHUB_ID/va-spec-python.git
cd va-spec-python
make devready
source venv/3.12/bin/activate
pre-commit install

Check style with ruff:

make format; make lint

Submodules

va-spec-python embeds va-spec as a submodule, only for testing purposes. When checking out va-spec-python and switching branches, it is important to make sure that the submodule tracks va-spec-python correctly. The recommended way to do this is git config --global submodule.recurse true. If you don't set submodule.recurse, developers and reviewers must be extremely careful to not accidentally upgrade or downgrade schemas with respect to va-spec-python.

If you already cloned the repo, but forgot to include --recurse-submodules you can run:

git submodule update --init --recursive

Testing

To run tests:

make test

Security Note (from the GA4GH Security Team)

A stand-alone security review has been performed on the specification itself. This implementation is offered as-is, and without any security guarantees. It will need an independent security review before it can be considered ready for use in security-critical applications. If you integrate this code into your application it is AT YOUR OWN RISK AND RESPONSIBILITY to arrange for a security audit.

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

4 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for alex.phd from gravatar.com alex.phd Avatar for jsstevenson from gravatar.com jsstevenson Avatar for korikuzma from gravatar.com korikuzma
+1 more Avatar for larry.babb from gravatar.com larry.babb

Credits

Author: Matt Brush, Javier Lopez

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache Software License (Apache License)

Requires

Python >=3.10

Provides Extra

dev tests notebooks

Tags

bioinformatics ga4gh genomics variation

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ga4gh_va_spec-0.4.4.tar.gz (43.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ga4gh_va_spec-0.4.4-py3-none-any.whl (32.9 kB view details)

Uploaded Python 3

File details

Details for the file ga4gh_va_spec-0.4.4.tar.gz.

File metadata

  • Download URL: ga4gh_va_spec-0.4.4.tar.gz
  • Upload date:
  • Size: 43.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ga4gh_va_spec-0.4.4.tar.gz
Algorithm Hash digest
SHA256 73b755cd3ca5fa808d16ce447b753a83d03014a99804350fd6f3c50867c95958
MD5 727f4cd3fdbfdfc7451ee056ea52efab
BLAKE2b-256 bcc59db36dd5b6db6bbbc2c9a9233efc5c80418590ddc1fadc7129f20086cd2d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ga4gh_va_spec-0.4.4.tar.gz:

Publisher: release.yaml on ga4gh/va-spec-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ga4gh_va_spec-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: ga4gh_va_spec-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 32.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ga4gh_va_spec-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5e763a50a1903a4e8bc30d40383ed339c4e846a13b9d35d926534b397b2899fa
MD5 dee8b5bea053ac288e3a5a4b64acd213
BLAKE2b-256 cc4ec889e3eff92753c179134416c5dbc388e7e6f4c5983b11a3065f070e72a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for ga4gh_va_spec-0.4.4-py3-none-any.whl:

Publisher: release.yaml on ga4gh/va-spec-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page