Skip to main content

QuranKit

A modular, Python-first computational Qur'anic research library

QuranKit provides reusable Python tools for accessing and navigating Qur'anic text, searching surahs, ayahs, and words, exploring Arabic words, roots, lemmas, and morphology when sourced annotation is available, analyzing repeated expressions and relationships between ayahs, and performing reproducible computational and statistical research.

Status

This project is in early pre-alpha development. The API is not stable and may change significantly.

Features (Planned)

  • Qur'anic text access — Preserve original source text with explicit edition identification
  • Arabic text processing — Unicode-aware normalization profiles for search and analysis
  • Lexicon and morphology — Root, lemma, and morphological analysis from sourced annotations
  • Search infrastructure — Exact, phrase, token, and word occurrence search
  • Mutashabihat analysis — Repeated phrase detection and textual relationship exploration
  • Computational research — Reproducible frequency, distribution, and co-occurrence analysis
  • Dataset governance — Provenance, licensing, and version tracking for all external data

Installation

pip install qurankit

For development with optional dependencies:

pip install qurankit[dev,tanzil,cli]

Quick Start

from qurankit import Quran

# Load a Quran instance (requires a dataset to be installed)
quran = Quran.load()

# Access surahs and ayahs
surah = quran.surah(1)  # Al-Fatihah
ayah = quran.ayah(1, 1)  # 1:1

print(f"Surah: {surah.name_arabic}")
print(f"Ayah: {ayah.text_original}")

Documentation

Principles

  1. Preserve originals — Never overwrite source Arabic text with normalized text
  2. Source traceability — Every annotation retains source, version, license, and attribution
  3. Separate evidence from inference — Distinguish source text, deterministic results, computational suggestions, and scholarly interpretation
  4. Reproducibility — Record dataset versions, algorithm versions, and normalization profiles
  5. Offline-capable — Core workflows work without hosted services after data installation
  6. Provider-neutral — No dependency on a particular LLM, cloud provider, or external API

License

MIT License — see LICENSE for details.

Third-party datasets have their own licenses. See docs/datasets.md for details.

Metadata

Release files for qurankit-core 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qurankit-core 0.1.0
File Size Uploaded Provenance Actions
qurankit_core-0.1.0.tar.gz 107.2 kB Without provenance Details for qurankit_core-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for qurankit-core 0.1.0
File Interpreter ABI Platform Actions
qurankit_core-0.1.0-py3-none-any.whl Python 3 none any Details for qurankit_core-0.1.0-py3-none-any.whl

Total release size: 175.1 kB

Release files / qurankit_core-0.1.0.tar.gz

Download URL qurankit_core-0.1.0.tar.gz
Size 107.2 kB
Tags Source
SHA-256 checksum
How to use checksums
99060253238f98bb36a818c3c9022c945210452970b25eda15e19424ee910607
BLAKE2b-256 checksum
How to use checksums
65cef6437040d12724ae2a919188126e39572e24271c7d289a338ea90014f692
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / qurankit_core-0.1.0-py3-none-any.whl

Download URL qurankit_core-0.1.0-py3-none-any.whl
Size 67.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9aadfb03d8273041f85fa59019b1118317d4266a83e7626480e62b1a531d58bf
BLAKE2b-256 checksum
How to use checksums
4ad164a9548c308cd825a053cf0deee0a578da5339be74179f5a3b41d595588a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Security for qurankit-core 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page