Metadata-Version: 2.1
Name: vcfvalidator
Version: 1.0.3
Summary: This package checks the metadata of VCF files with respect to the following paper: https://f1000research.com/articles/11-231
License: MIT
Author: Junaid Memon
Author-email: jmemonisy@gmail.com
Maintainer: Patrick König
Maintainer-email: koenig@ipk-gatersleben.de
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: rich (>=12.6.0,<13.0.0)
Requires-Dist: tabulate (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# vcfvalidator

This package checks the metadata of VCF files with respect to the following paper: https://f1000research.com/articles/11-231


### Installing the package:

```
pip install vcfvalidator
```

### How to use the validator:

The package installs a CLI tool that can be used to check the VCF metdata with the following command:
```
$ vcfvalidator validate-metadata PATH_TO_VCF_FILE
```

The VCF file under PATH_TO_VCF_FILE can be either compressed with GZIP (*.vcf.gz) or uncompressed (*.vcf).
