Skip to main content

A pure-Python utility library for CRISPR and prime editing sequence design and validation.

Project description

crispr-toolkit

A small, pure-Python utility library for CRISPR and prime-editing sequence design, validation, and basic scoring. This package is intended as a clean, well-tested FOSS backend for browser tools and scripting workflows.

This project is fully independent from Helix Studio internals and is provided as a standalone, open-source utility library.

Installation

python -m pip install crispr-toolkit

Quickstart

from crispr_toolkit import (
    normalize_seq,
    find_pam_sites,
    validate_guide,
    design_pegRNA,
    basic_on_target_score,
)

seq = normalize_seq("acgtacgtGGGcttacggt")
sites = find_pam_sites(seq, "NGG")
result = validate_guide(seq[2:24])

print(sites)
print(result.is_valid, result.gc_content)

# Example: simple prime editing scaffold
components = design_pegRNA(
    ref_seq=seq,
    edit_pos=5,
    edit_type="substitution",
    edit_seq="A",
)
print(components.pbs, components.rtt)

# Example: basic rule-based on-target score
score = basic_on_target_score(seq[2:22])
print(score)

Roadmap

Planned future features include:

  • More PAM presets and convenience helpers.
  • Simple off-target enumeration utilities.
  • Additional rule-based prime editing recipes and presets.

License

This project is released under the MIT License. See LICENSE for details.

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

crispr_toolkit-0.1.0.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

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

crispr_toolkit-0.1.0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: crispr_toolkit-0.1.0.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for crispr_toolkit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bea2b0c780352a0582effd9d3fefaf6ae8f7c693af32c847faa5714767832fe4
MD5 7f90bf315b9682865a28f2f48e42ce44
BLAKE2b-256 36a5c8b42371d8837350fd5f99df6124fb58b92487b6ddbe01b486fc423c4537

See more details on using hashes here.

Provenance

The following attestation bundles were made for crispr_toolkit-0.1.0.tar.gz:

Publisher: release.yml on omniscoder/crispr-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: crispr_toolkit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for crispr_toolkit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ee5fbd360379421cc0da2a0eb4215d227f02498ec922508a9b2b5ad51ea7bd2
MD5 46069013f3bb562ca6706259f69da440
BLAKE2b-256 d83c69b84174330ca573a9654cbe08118747f82979c88bdd8270fcb06ba5900f

See more details on using hashes here.

Provenance

The following attestation bundles were made for crispr_toolkit-0.1.0-py3-none-any.whl:

Publisher: release.yml on omniscoder/crispr-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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