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

Publish PyPI - Version TestPyPI 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.

For Users

For Developers

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.2.0.tar.gz (362.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.2.0-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bioquik-0.2.0.tar.gz
  • Upload date:
  • Size: 362.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for bioquik-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b41978942ec28362d5a8b00961612811c3c48a1fa2d58eeb30dba17498b2b2a1
MD5 9f1796afcaebb2b684554be167d1d7f4
BLAKE2b-256 f283b57d0fa61735361af6603221aef839d6aa42cb40c4f43de748477e4d6555

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bioquik-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for bioquik-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e52a50de1c5b022cd0d488f6bb170bcc9276f4a8608d78496373401a9d5b7160
MD5 87285d3db03a670f051c4d7c7526d12b
BLAKE2b-256 457784b2050a72b81600d47e21071adc57c9a7190835c812c2129e662263c85f

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