Skip to main content

VCFPy

https://img.shields.io/pypi/v/vcfpy.svg https://img.shields.io/travis/bihealth/vcfpy.svg Documentation Status Updates

Python 3 VCF library with good support for both reading and writing

Features

  • Support for reading and writing VCF v4.3

  • Interface to INFO and FORMAT fields is based on OrderedDict allows for easier modification than PyVCF (also I find this more pythonic)

  • Read (and jump in) and write BGZF files just using vcfpy

Why another VCF parser for Python!

I’ve been using PyVCF with quite some success in the past. However, the main bottleneck of PyVCF is when you want to modify the per-sample genotype information. There are some issues in the tracker of PyVCF but none of them can really be considered solved. I tried several hours to solve these problems within PyVCF but this never got far or towards a complete rewrite…

For this reason, VCFPy was born and here it is!

What’s the State?

VCFPy is the result of two full days of development plus some maintenance work later now (right now). I’m using it in several projects but it is not as battle-tested as PyVCF.

Why Python 3 Only?

As I’m only using Python 3 code, I see no advantage in carrying around support for legacy Python 2 and maintaining it. At a later point when VCFPy is known to be stable, Python 2 support might be added if someone contributes a pull request.

History

HEAD

0.3.1 (2016-09-21)

  • Work around FORMAT/FT being a string; this is done so in the Delly output

0.3.0 (2016-09-21)

  • Reader and Writer can now be used as context manager (with with)

  • Including license in documentation, including Biopython license

  • Adding support for writing bgzf files (taken from Biopython)

  • Adding support for parsing arrays in header lines

  • Removing example-4.1-bnd.vcf example file because v4.1 tumor derival lacks ID field

  • Adding AltAlleleHeaderLine, MetaHeaderLine, PedigreeHeaderLine, and SampleHeaderLine

  • Renaming SimpleHeaderFile to SimpleHeaderLine

  • Warn on missing FILTER entries on parsing

  • Reordered parameters in from_stream and from_file (#18)

  • Renamed from_file to from_stream (#18)

  • Renamed Reader.jump_to to Reader.fetch

  • Adding header_without_lines function

  • Generally extending API to make it esier to use

  • Upgrading dependencies, enabling pyup-bot

  • Greatly extending documentation

0.2.1 (2016-09-19)

  • First release on PyPI

Download files

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

Source Distribution

vcfpy-0.3.1.tar.gz (966.1 kB view details)

Uploaded Source

Built Distribution

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

vcfpy-0.3.1-py2.py3-none-any.whl (25.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file vcfpy-0.3.1.tar.gz.

File metadata

  • Download URL: vcfpy-0.3.1.tar.gz
  • Upload date:
  • Size: 966.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for vcfpy-0.3.1.tar.gz
Algorithm Hash digest
SHA256 344dda66707c44599f4ef73df46a90626da7218419e11b36f756bc40ca6131b1
MD5 0259e6c42e3460ccda3127b4c107382d
BLAKE2b-256 b3d0d25fc60944f3961f5bde2a5fafeca4a6de003daf25f2b2bc86db6a6b8dd1

See more details on using hashes here.

File details

Details for the file vcfpy-0.3.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for vcfpy-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2955b58f4c6b63b4ce9edf2d5f8d253638145d9f78d753d513d8b33845999ee0
MD5 00d1c965e8f05c84db3c3a6f4236d532
BLAKE2b-256 06680233645d26e36a2513d246d0918df2ac36dade9f2c5debf3bdc56104ea7d

See more details on using hashes here.

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