Metadata-Version: 2.4
Name: pyBGZ
Version: 1.0.5
Summary: Tool for bgzip compress FastQ files.
Project-URL: Documentation, https://forgejo.remylebeau.uk/Godrigos/pybgz#readme
Project-URL: Issues, https://forgejo.remylebeau.uk/Godrigos/pybgz/issues
Project-URL: Source, https://forgejo.remylebeau.uk/Godrigos/pybgz
Author-email: Rodrigo Aluizio <r.aluizio@gmail.com>
License-Expression: LGPL-3.0-or-later
License-File: LICENSE.txt
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.10
Requires-Dist: biopython~=1.86
Requires-Dist: rich~=14.2
Requires-Dist: typer~=0.20
Description-Content-Type: text/markdown

# pyBGZ

A tool to compress genomic data in [FastQ](https://en.wikipedia.org/wiki/FASTQ_format) format using [Blocked GNU Zip](https://en.wikipedia.org/wiki/BGZF).

-----

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## Installation

Download [pyBGZ](https://forgejo.remylebeau.uk/Godrigos/-/packages/pypi/pybgz) package and install it using pip.

```console
pip install pybgz-1.0.5-py3-none-any.whl
```

## Usage

```
pybgz INPUT_FILE
```

Arguments: input_file PATH [required]                                

> **Note**: 
> `pyBGZ` will remove any information at field 3 (third line) which, when present, are repeated informations from field 1 (first line). This helps reducing the size of the compressed file. No sequence or quality information will be modified.

## License

`pyBGZ` is distributed under the terms of the [LGPL-3.0-or-later](https://spdx.org/licenses/LGPL-3.0-or-later.html) license.
