Metadata-Version: 2.4
Name: deacon
Version: 0.16.0rc1
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Summary: Fast DNA search and [host] depletion using minimizers
License-Expression: MIT
Requires-Python: >=3.12
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://github.com/bede/deacon
Project-URL: Repository, https://github.com/bede/deacon

# Deacon Python bindings

Enables index reuse between filtering sessions.

```python
from deacon import Index

index = Index("panhuman-1.k31w15.idx")
stats = [
    index.filter(fq, deplete=True, rename=True,
                 output=fq.replace(".fastq.gz", ".clean.fastq.gz"))
    for fq in input_fastqs
]
print(stats[0]["seqs_in"], stats[0]["seqs_out"])
```

`filter` accepts single or paired input (`fastq2=`, `output2=`), auto-detects `.gz`/`.zst`/
`.xz` output compression from the extension, and returns a `dict` of summary statistics.
`from deacon import filter` also exposes `filter(index, ...)` as a free function.

