Metadata-Version: 2.1
Name: genome-kmers
Version: 0.1.2
Summary: fast and memory-efficient genomic k-mer calculations
License: LICENSE
Author: Matthew Perkett
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: biopython (>=1.83,<2.0)
Requires-Dist: numba (>=0.59.1,<0.60.0)
Requires-Dist: numpy (>=1.26.4,<2.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Description-Content-Type: text/markdown

# Introduction

This Python package implements objects and functions that allow for fast and memory-efficient [*k*-mer](https://en.wikipedia.org/wiki/K-mer) calculations on the genome.  See the [genome-kmers homepage](https://genome-kmers.readthedocs.io/en/latest/index.html) for a detailed overview, examples, dev setup, and API reference.

This package can be installed via PyPI

```shell
pip install genome-kmers
```

or via cloning the repo and installing (e.g. using [poetry](https://python-poetry.org/))

```bash
git clone git@github.com:mrperkett/genome-kmers.git
cd genome-kmers/

poetry install

# run tests to verify everything is working properly
poetry run python -m pytest
```
