Skip to main content

Local-first biological sequence search engine

Project description

bio-grep

bio-grep is a local-first biological search engine for fast iterative querying over FASTA, FASTQ, GFF3, GTF, BED, VCF, SAM/BAM, GenBank, and EMBL corpora.

Install

pip install "bio-grep[bam]"

or

uv tool install "bio-grep[bam]"

One-line installer (tag-pinned):

curl -fsSL https://raw.githubusercontent.com/ravishar313/bio-grep/v0.1.1/scripts/install.sh | bash

Quick Start

Index one or more files:

bio-grep index data/fasta/*.fasta --index-dir . --k 7

Run a motif search:

bio-grep search --motif "C..C" --top-k 20 --index-dir .

Search annotation formats:

bio-grep search --file-type gff --region "chr1:120-300" --feature-type-exact gene --top-k 20 --index-dir .
bio-grep search --file-type vcf --region "chr1:1-1000000" --filter-exact PASS --top-k 20 --index-dir .
bio-grep search --file-type sam --seqid-exact chr1 --mapq-gte 30 --top-k 20 --index-dir .

Fetch full sequence payload by ID:

bio-grep fetch s1 --index-dir .

Highlights

  • Agent-first compact jsonl output by default.
  • Stable metadata keys (null when unavailable).
  • Rich filter support for sequence and annotation search.
  • --version flag for CLI/version pinning workflows.

Python API

from pathlib import Path
from bio_grep.engine import BioGrep

bio = BioGrep(base_dir=Path("."), k=7)
bio.index([Path("data/fasta/uniprot_reviewed_human_250.fasta")])
rows = bio.search(motif="C..C", length_lt=200).top_k(10)
print(rows[0]["id"], rows[0]["score"])

Project Links

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

bio_grep-0.1.1.tar.gz (58.0 kB view details)

Uploaded Source

Built Distribution

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

bio_grep-0.1.1-py3-none-any.whl (62.3 kB view details)

Uploaded Python 3

File details

Details for the file bio_grep-0.1.1.tar.gz.

File metadata

  • Download URL: bio_grep-0.1.1.tar.gz
  • Upload date:
  • Size: 58.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.6

File hashes

Hashes for bio_grep-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6e400a60880688478e3fe5ec9ac46dc003a11f82162ed9db8201fc2a19fc6af9
MD5 9ccd1b190ba878e482d4e4c74533e8f2
BLAKE2b-256 b0ceaf995c6c57dcd0cc2f91edd3eee3d5efc1c68de23524cef1cf2bf08ba50d

See more details on using hashes here.

File details

Details for the file bio_grep-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: bio_grep-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 62.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.6

File hashes

Hashes for bio_grep-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e95207953f9c57497737d9ac86ce7d0e64cdc053c69a58db18fcffea256a1762
MD5 6b41143477bfb0465f8afb2fab1ad8a8
BLAKE2b-256 5085ad9b20d11aeef99d23c2f7ef890d2c99ec8310f6cf63135b554a8cb26605

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