Skip to main content

bioquik is a fast and extensible command-line toolkit for counting CG-anchored DNA motifs in FASTA files. Designed to accelerate bioinformatics pipelines with a simple and parallel interface.

Project description

bioquik

bioquik is a fast and extensible command-line toolkit for counting CG-anchored DNA motifs in FASTA files. Designed to accelerate bioinformatics pipelines with a simple and parallel interface.

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Docs GitHub license Build Status codecov Ruff

PyPI - Version Python Versions Keep a Changelog Contributor Covenant

Features

  • Expand wildcard patterns (e.g. **CG**) into exact motifs
  • Count motifs using a memory-efficient FM-index
  • Parallel processing of multiple FASTA files
  • Generates:
    • Per-file CSVs
    • Combined summary CSV
    • Optional JSON summary
    • Optional plots (motif distribution, frequency heatmap)
  • Rich progress indicators
  • Fully tested with Pytest

Installation

For users (latest release from PyPI):

pip install bioquik

For developers (editable mode + dev dependencies):

git clone https://github.com/Rajkanwars15/bioquik
cd bioquik
pip install -e '.[dev,docs]'

Requirements

  • Python ≥ 3.9
  • Linux/macOS (tested); Windows should work with minor path adjustments

Documentation

Full docs are hosted on Read the Docs.

License

This project is licensed under the terms of the MIT License.

Author

Static Badge

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bioquik-0.1.0.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bioquik-0.1.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file bioquik-0.1.0.tar.gz.

File metadata

  • Download URL: bioquik-0.1.0.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for bioquik-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d48b98f1349193775ccdbb8c52b7d9651f62345a259b68de56bcd842c2885bbc
MD5 054205b6eaca7c63382e612df048c63f
BLAKE2b-256 c2ff42e0c2bde307a430c7dcb29ef6f52ad49cdbf1df7e9ec4e90b7785e734b6

See more details on using hashes here.

File details

Details for the file bioquik-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: bioquik-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for bioquik-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 89211104e174a38444ccd8c663bf03d966b330644445d97dadd62264ad1a8c09
MD5 fc446d2b787254aa4e3559be0782f23d
BLAKE2b-256 9bf83f3d63604583ce4ca6fdb0f3e66b8efe50dd1ec36191e6fde2c5f22aa611

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page