Metadata-Version: 2.2
Name: Bamurai
Version: 0.1.0
Summary: A package for splitting reads BAM files into smaller fragments.
Author: Shian Su
License: Apache-2.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pysam
Requires-Dist: numpy
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: mypy; extra == "dev"

# Bamurai

A Python package for splitting reads BAM files into smaller fragments.

## Description

Bamurai is a command-line tool that splits reads in BAM files to a rough target length and outputs a FASTQ file. This is useful for testing the performance of bioinformatics tools on long-reads data at different read lengths.

## Installation

```bash
pip install git+https://github.com/Shians/Bamurai.git
```

## Usage

To split a file into 10,000 bp reads
```bash
bamurai split --input input.bam --target-length 10000 --output output.fastq
```

To create a gzipped output file
```bash
bamurai split --input input.bam --target-length 10000 | gzip > output.fastq.gz
```
