Metadata-Version: 2.4
Name: crispr-toolkit
Version: 0.1.0
Summary: A pure-Python utility library for CRISPR and prime editing sequence design and validation.
Project-URL: Homepage, https://github.com/omniscoder/crispr-toolkit
Project-URL: Repository, https://github.com/omniscoder/crispr-toolkit
Author: OmnisCoder
License: MIT
License-File: LICENSE
Keywords: bioinformatics,crispr,genome-editing,prime-editing
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.10
Provides-Extra: test
Requires-Dist: pytest>=7.0; extra == 'test'
Description-Content-Type: text/markdown

# 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

```bash
python -m pip install crispr-toolkit
```

## Quickstart

```python
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.
