Metadata-Version: 2.3
Name: vcf2xlsx
Version: 0.2.0
Summary: CLI tool to convert a vcf file to an xlsx file
Author: Trent Zeng
Author-email: trentzz.dev@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: argparse (>=1.4.0,<2.0.0)
Requires-Dist: vcf2pandas (>=0.2.0,<0.3.0)
Requires-Dist: xlsxwriter (>=3.2.2,<4.0.0)
Description-Content-Type: text/markdown

# vcf2xlsx

A lightweight cli wrapper for [vcf2pandas](https://github.com/trentzz/vcf2pandas) that converts a Variant Call Format (VCF) file to an excel spreadsheet.

For more information about the format of the excel spreadsheet, naming, or otherwise, see [vcf2pandas](https://github.com/trentzz/vcf2pandas).

## Install

```bash
pipx install vcf2xlsx
```

## Usage

```bash
vcf2xlsx <vcf-filename>.vcf
```

Outputs `<vcf-filename>.xlsx` by default.

```bash
  -o OUTPUT, --output OUTPUT
                        Path to the XLSX file.
  -r, --remove-empty-columns
                        Remove empty columns.
```

## Examples

```bash
vcf2xlsx examples/example.vcf -o examples/example.xlsx
```

