quran-processing-toolkit 0.4.0__tar.gz

quran_processing_toolkit-0.4.0/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+## 0.4.0 — 2026-11-12
+
+First release of `quran-processing-toolkit` on production PyPI, paired with
+`quran-processing-toolkit-qac-data==0.4.0`. Earlier versions were development and
+TestPyPI previews. This release is early-stage; future minor releases may introduce
+changes documented here.
+
+### Included
+
+- Typed corpus model: 114 chapters, 6,236 verses, 77,429 QAC-aligned words,
+  128,219 morphology tokens, and 30 juz divisions.
+- Quranic 1-based address lookup and composable immutable query results.
+- Arabic and ASCII Buckwalter text search with explicit normalization.
+- Token and word morphology filters, grouping, counts, root/lemma sets, and
+  nun-of-emphasis detection tied to the annotated verb stem.
+- Cached part-of-speech token selections, including proper nouns, pronouns,
+  adjectives, adverbs, prepositions, conjunctions, nominals, and particles.
+- Arabic, ASCII, and English chapter names with attributed metadata.
+- Exact pairwise surface-word comparison for a one-word addition, substitution,
+  or shift, with an explicit pause-mark policy.
+- Optional local TXT/JSON translation layers with provenance and coverage checks;
+  explicit pinned download/cache support for Qara'i from Tanzil.
+- CLI commands for stats, search, word inspection, sources, validation, and
+  deterministic morphology rebuilds.
+- Source hash verification and a reproducible derived-record cache outside the
+  installed packages. No translation is bundled or downloaded implicitly.
+- Task-oriented documentation, an AI usage guide, `llms.txt`, and runnable examples.
+
+### Migration from the 0.3.0 TestPyPI preview
+
+The old `quran.verbs` and `quran.nouns` properties selected whole words. Rename
+these to `quran.verb_words` and `quran.noun_words` to preserve that behavior.
+Use `quran.verbs()` and `quran.nouns()` for individual morphological tokens.
+
+On a token, `form` / `get_form()` is surface spelling; `verb_form` is the
+morphological Roman numeral. Query `with_form("IV")` selects the morphological form.
+Word-level `get_form()` retains its morphological meaning. Use token queries when
+all chained conditions must match a single stem in a multi-stem word.
+
+### Source-data distribution 0.4.0
+
+Packages the verbatim QAC morphology 0.4 and Tanzil Uthmani text 1.1, a juz-boundary
+table, an integrity manifest, and complete source-specific license notices.
+See [Data provenance](docs/DATA_PROVENANCE.md) for exact hashes and terms.

quran_processing_toolkit-0.4.0/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing
+
+Contributions are welcome, particularly readable query helpers, documentation, tests,
+performance improvements with measured benefit, and source-preserving morphology
+interpretations.
+
+## Non-negotiable data rule
+
+Do not edit Quranic text, morphology records, tags, roots, lemmas, or other material
+annotations in place.
+
+If an upstream record appears wrong:
+
+1. record the exact address and source feature text;
+2. explain the linguistic evidence;
+3. propose either a documented runtime interpretation or an upstream report;
+4. add a focused test; and
+5. obtain explicit project approval before changing any semantic overlay.
+
+Verbatim third-party source files must remain byte-identical to their declared hashes.
+Any accepted transformation change must increment `TRANSFORMATION_VERSION`, update the
+canonical derived digest, and be documented in
+[`docs/PROPOSED_CORPUS_CHANGES.md`](docs/PROPOSED_CORPUS_CHANGES.md).
+
+## Development setup
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install -e packages/quran_processing_toolkit_qac_data
+python -m pip install -e ".[dev]"
+```
+
+On Windows PowerShell, activate with `.venv\Scripts\Activate.ps1`.
+
+## Required checks
+
+```bash
+ruff check .
+ruff format --check .
+mypy quran_processing_toolkit packages/quran_processing_toolkit_qac_data/src
+python -m unittest discover -s tests -v
+python -m quran_processing_toolkit.build --check
+python -m quran_processing_toolkit validate
+```
+
+Also run every relevant script in `examples/`. CI repeats checks across supported
+Python versions, builds both distributions, runs `twine check`, and smoke-installs the
+wheels outside the checkout.
+
+## API design principles
+
+Good additions make a family of questions easier rather than encoding one answer.
+
+Prefer:
+
+- `starts_with(prefix)` over `starts_with_alif()`;
+- `with_number("plural")` over `first_person_plural_verbs()`;
+- `in_verse(chapter, verse)` over a helper named after one famous verse; and
+- composable immutable results over functions that print immediately.
+
+Named helpers are valuable when they remove routine lambdas or knowledge of internal
+uppercase fields. They should delegate to the generic query machinery where practical
+so named and advanced queries behave consistently.
+
+Public text input should remain ASCII-friendly through Buckwalter. New categorical
+arguments should normally be case-insensitive and accept obvious source abbreviations.
+Roots, lemmas, surface forms, and raw features remain case-sensitive because character
+case may be meaningful.
+
+## Documentation expectations
+
+Any public API change should update:
+
+- its Python docstring;
+- [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md);
+- the relevant conceptual guide or cookbook example; and
+- tests demonstrating expected behavior and failure cases.
+
+Comments should explain invariants, source mismatches, or non-obvious decisions—not
+translate straightforward Python line by line.
+
+## Testing guidance
+
+- Use canonical addresses for focused regression tests.
+- Assert source fields and derived fields separately.
+- Include multi-stem behavior when an aggregation API changes.
+- Test both Arabic and Buckwalter for text operations.
+- Test aliases and canonical categorical values.
+- Avoid copying copyrighted translation text into fixtures; authored placeholder text
+  is sufficient.
+- Never weaken source hash or derived digest verification to make a test pass.
+
+## Performance changes
+
+Measure at least:
+
+- a fresh uncached process load;
+- a derived-disk-cache process load;
+- a repeated in-process `load_quran()` call; and
+- the target query on the complete corpus.
+
+Report Python version, platform, command, and whether `orjson` was installed. Avoid
+performance changes that discard source traceability, alter public ordering, or turn
+simple imports into mandatory compiled dependencies.
+
+## Compatibility
+
+The public package supports Python 3.10 and newer. Preserve:
+
+- Quranic 1-based semantic indexing;
+- normal zero-based positions inside filtered QuerySets;
+- deterministic corpus order;
+- source-feature visibility;
+- the separate code/data distribution boundary; and
+- user-installed rather than bundled translation files.
+
+Deprecated compatibility aliases may remain when inexpensive, but new documentation
+should teach the clearest current API.
+
+## Releases
+
+Core and data distributions have independent versions and tags. Do not publish either
+manually with a long-lived token. Follow [`docs/RELEASING.md`](docs/RELEASING.md),
+publishing the data distribution before a core release whose `data` extra pins it.

quran_processing_toolkit-0.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

quran_processing_toolkit-0.4.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include LICENSE
+include README.md
+include CONTRIBUTING.md
+include requirements.txt
+include tools.py
+include verses_per_juzz.py
+recursive-include docs *.md
+recursive-include examples *.py
+recursive-include tests *.py *.txt
+include THIRD_PARTY_NOTICES.md
+include CHANGELOG.md
+include llms.txt

quran_processing_toolkit-0.4.0/PKG-INFO

@@ -0,0 +1,269 @@
+Metadata-Version: 2.4
+Name: quran-processing-toolkit
+Version: 0.4.0
+Summary: Natural, queryable access to Quranic text and morphology
+Author: Maysum Panju
+License-Expression: Apache-2.0 AND LicenseRef-Tanzil-Metadata-CC-BY
+Project-URL: Homepage, https://github.com/mhpanju/QuranProcessingToolkit
+Project-URL: Documentation, https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/README.md
+Project-URL: Repository, https://github.com/mhpanju/QuranProcessingToolkit
+Project-URL: Issues, https://github.com/mhpanju/QuranProcessingToolkit/issues
+Project-URL: Changelog, https://github.com/mhpanju/QuranProcessingToolkit/blob/master/CHANGELOG.md
+Keywords: quran,arabic,corpus,morphology,linguistics,buckwalter
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: licenses/TANZIL-METADATA-NOTICE.txt
+Provides-Extra: fast
+Requires-Dist: orjson>=3.10; extra == "fast"
+Provides-Extra: data
+Requires-Dist: quran-processing-toolkit-qac-data==0.4.0; extra == "data"
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: mypy>=1.17; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.12; extra == "dev"
+Requires-Dist: twine>=6; extra == "dev"
+Dynamic: license-file
+
+# Quran Processing Toolkit
+
+Typed Python access to Quranic text, morphology, and composable research queries.
+Search in Arabic or ASCII Buckwalter, inspect every original annotation, and address
+chapters, verses, words, and tokens using Quranic 1-based indexes.
+
+Requires **Python 3.10+**. Version **0.4.0** is the first production PyPI release;
+the API is early-stage and future minor releases may introduce documented changes.
+
+## Install and run
+
+```bash
+python -m pip install "quran-processing-toolkit[data]"
+```
+
+```python
+from quran_processing_toolkit import load_quran
+
+quran = load_quran()
+assert len(quran.chapters) == 114
+assert len(quran.verses) == 6236
+
+print(quran.chapter(2).name)  # al-Baqarah
+print(quran.verse(2, 255).get_arabic())
+
+# ASCII search input is Buckwalter, so an Arabic keyboard is optional.
+quran.search("muwsaY").show("arabic", limit=3)
+
+# These are verb tokens: all filters apply to the same morphological stem.
+present = quran.verbs().with_tense("present")
+print(present.most_common_forms(limit=5))
+
+quran.verses.ends_with("n", strip_diacritics=True).show("arabic", limit=3)
+```
+
+Loading is offline and verifies the installed source data. Nothing is downloaded
+implicitly. The core has no mandatory third-party Python dependencies. Code and data
+are separate distributions because their licenses differ; the `data` extra installs
+the matching source-data package. For optional faster cache decoding, install
+`"quran-processing-toolkit[data,fast]"`.
+
+## What you can do
+
+| Task | API | Guide |
+|---|---|---|
+| Look up an address | `quran.verse(2, 255)` | [Getting started](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/GETTING_STARTED.md) |
+| Search Arabic or Buckwalter | `quran.search("muwsaY")` | [Query cookbook](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/QUERY_COOKBOOK.md) |
+| Filter stems by root, form, tense, voice, person, or number | `quran.verbs().with_root("qwl")` | [Morphology](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/MORPHOLOGY.md) |
+| Select nouns, pronouns, particles, and other parts of speech | `quran.nouns()`, `quran.pronouns()` | [API reference](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/API_REFERENCE.md) |
+| Count, group, and export results | `results.count_by("root")`, `results.select("address")` | [Cookbook](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/QUERY_COOKBOOK.md) |
+| Compare two verses for one-word edits | `compare_verses(a, b)` | [Comparison API](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/API_REFERENCE.md#chapter-names-and-surface-word-comparison) |
+| Add a local translation or explicitly download one | `load_translation()`, `download_translation()` | [Translations](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/TRANSLATIONS.md) |
+| Inspect sources and validate the corpus | `quran.provenance()`, `quran-toolkit validate` | [Data provenance](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/DATA_PROVENANCE.md) |
+
+SQL and a database server are not required. Named helpers cover ordinary queries;
+`where()`, `filter()`, `group_by()`, and `count_by()` support custom analyses.
+
+## Addresses, words, and tokens
+
+```python
+chapter = quran.chapters[1]
+verse = quran.verses[2, 255]
+word = quran.words[2, 255, 1]
+token = quran.tokens[2, 255, 1, 1]
+juz = quran.juzs[1]
+
+results = quran.verbs().in_chapter(2)
+first_result = results[0]  # filtered results use ordinary zero-based positions
+```
+
+A **word** is a QAC-aligned orthographic word. A **token** is one morphological
+segment: prefixes, stems, and suffixes can be separate tokens inside a word.
+`quran.verbs()` and `quran.nouns()` return tokens; `quran.verb_words` and
+`quran.noun_words` return whole words. Chained word filters aggregate stem values,
+so use token queries when all conditions must match a single stem.
+
+On a token, `form` is its surface spelling and `verb_form` is its Roman-numeral
+morphological form. The query `with_form("IV")` selects the morphological form.
+Roots and lemmas use case-sensitive Buckwalter; categorical aliases such as
+`"present"`, `"IMPF"`, `"passive"`, and `"PASS"` are accepted by the relevant helpers.
+
+See [Data model and indexing](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/DATA_MODEL.md)
+for multi-stem behavior and the full hierarchy.
+
+## Compose research queries
+
+```python
+# Roots found in first-person plural verbs but never first-person singular verbs.
+plural = quran.verbs().with_person(1).with_number("plural")
+singular = quran.verbs().with_person(1).with_number("singular")
+plural_only_roots = plural.roots() - singular.roots()
+
+# Three-letter noun roots with at least two weak letters.
+weak_roots = quran.nouns().with_root_length(3).with_minimum_root_letter_count("Awy", 2)
+
+# Explicit nun-of-emphasis annotations associated with their verb stem.
+emphatic = quran.verbs().with_nun_of_emphasis()
+assert len(emphatic) == 243
+
+# The longest within-verse word run containing neither mim nor nun.
+longest = quran.longest_word_sequence_without_letters("mn", strip_diacritics=True)
+
+# Preserve access to every original annotation.
+token = quran.token(2, 38, 6, 1)
+print(token.source_feature_text)
+print(token.source_features)
+```
+
+Text matching is literal by default. ASCII input selects Buckwalter; non-ASCII
+input selects Arabic. Pass normalization options explicitly, for example
+`strip_diacritics=True`, `strip_quranic_marks=True`, or `normalize_alif=True`.
+Use `representation="translation"` for translation search so English input is
+not interpreted as Buckwalter.
+
+## Translations and verse comparison
+
+Translations are optional. Load your own UTF-8 `chapter|verse|text` file or supported
+JSON file:
+
+```python
+translated = load_quran(translation="/path/to/translation.txt")
+print(translated.verse(1, 1).get_translation())
+```
+
+An explicit, hash-verified downloader is also available:
+
+```python
+from quran_processing_toolkit import compare_verses, download_translation
+
+# This call opts into a network download on first use.
+translated = load_quran(translation=download_translation("en.qarai"))
+translated.require_translation()  # require coverage of all 6,236 verses
+
+changes = compare_verses(
+    quran.verse(27, 68),
+    quran.verse(23, 83),
+    ignore_pause_marks=True,
+)
+for change in changes:
+    print(change.kind, change.verse_a.address, change.verse_b.address)
+```
+
+The catalog currently contains Ali Quli Qarai's English translation from Tanzil.
+Its terms specify non-commercial use unless permission is obtained from the
+translator or publisher. Downloads are cached outside the package and support
+`offline=True`. Missing translation output raises `TranslationNotAvailableError`.
+See [Translations](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/TRANSLATIONS.md)
+for terms, formats, coverage checks, and provenance.
+
+`compare_verses()` explains a single-word addition, substitution, or shift between
+two verses. It returns zero or one match, rather than a general similarity score.
+Its space-delimited surface positions differ from QAC word addresses; it performs
+no spelling or vowel normalization.
+
+## Command line
+
+```bash
+quran-toolkit stats
+quran-toolkit search muwsaY --level verse --limit 5
+quran-toolkit word 2:255:1
+quran-toolkit sources
+quran-toolkit validate
+quran-rebuild --check
+```
+
+The [CLI reference](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/CLI.md)
+explains all commands, options, and exit behavior.
+
+## Integrity and caching
+
+Every newly constructed corpus verifies source filenames, sizes, and SHA-256 hashes,
+plus the canonical derived morphology digest. Later equivalent `load_quran()` calls
+reuse the same in-process object. A local derived JSON cache speeds up new processes;
+installed source files are never changed.
+
+```python
+fresh = load_quran(cache=False)  # a new object graph
+uncached = load_quran(cache=False, disk_cache=False)  # rederive from source
+```
+
+Set `QURAN_PROCESSING_TOOLKIT_CACHE` or pass `cache_dir=...` to relocate the derived
+cache. Read-only cache locations fall back to uncached loading. See
+[Architecture](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/ARCHITECTURE.md).
+
+## Documentation for people and AI assistants
+
+Start at the [documentation index](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/README.md).
+The [AI usage guide](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/AI_GUIDE.md)
+provides a compact, executable introduction, task-to-API mapping, and common mistakes.
+[`llms.txt`](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/llms.txt)
+links to the authoritative Markdown references.
+
+- [Getting started](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/GETTING_STARTED.md)
+- [Query cookbook](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/QUERY_COOKBOOK.md)
+- [API reference](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/API_REFERENCE.md)
+- [Morphology reference](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/MORPHOLOGY.md)
+- [Release notes and preview migration](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/CHANGELOG.md)
+- [Runnable examples](https://github.com/mhpanju/QuranProcessingToolkit/tree/master/examples), including a [complete verb JSON exporter](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/examples/export_verb_index.py)
+- [Known limits and roadmap](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/ROADMAP.md)
+- [Contributing](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/CONTRIBUTING.md)
+
+## Development
+
+```bash
+python -m venv .venv
+. .venv/bin/activate
+python -m pip install -e packages/quran_processing_toolkit_qac_data
+python -m pip install -e ".[dev]"
+ruff check .
+ruff format --check .
+mypy quran_processing_toolkit packages/quran_processing_toolkit_qac_data/src
+python -m unittest discover -s tests -v
+python -m quran_processing_toolkit.build --check
+python -m quran_processing_toolkit validate
+```
+
+The historical `from tools import QuranCorpus` import is available in source
+checkouts. Installed applications should import `quran_processing_toolkit`.
+
+## License and attribution
+
+The Python code is Apache-2.0. The core also includes separately attributed Tanzil
+chapter-label metadata, whose upstream declaration is CC-BY without a version;
+see [Third-party notices](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/THIRD_PARTY_NOTICES.md).
+The data package preserves the QAC and Tanzil sources verbatim under their respective
+upstream terms, with full notices. No translation is bundled. Read
+[Data provenance and licensing](https://github.com/mhpanju/QuranProcessingToolkit/blob/master/docs/DATA_PROVENANCE.md)
+before redistributing data or derived artifacts.