quran-text for Python

No dependencies, Python 3.9+. Ḥafṣ is bundled. Copy quran_text.py and quran_text_data/ into your project, or pip install this directory.

from quran_text import Mushaf, AyahMap

m = Mushaf.hafs()                                    # bundled Ḥafṣ
m.ayah(2, 255).text                                  # plain words
m.ayah(2, 255).render(marks=True, ayah_marks=True) # with waqf marks and ۝٢٥٥
m.page(3).render(marks=True, ayah_marks=True, lines=True)
m.surah(112).ayahs                                     # [Ayah(112:1), …]
m.juz(30).first_ayah.key                             # "78:1"
m.word(1, 4, 1).number                               # 11, the same word in every riwāyah
m.sajdat()                                           # every āyah printed with ۩
m.search("مالك يوم الدين")                           # [Span(10, 13)]

w = Mushaf.load("data/mushaf/warsh.json")            # another riwāyah
AyahMap.load("data/ayah-map.json").convert(2, 255, "warsh")   # MappedAyah(2, 253, 'split', 254)

The font the text needs is bundled too: m.font.family names it and m.font.path is the .ttf. For another riwāyah Mushaf.load(path) finds its font beside data/fonts/.

Wrong numbers raise IndexError; a layer the file lacks (juz in Bazzī) raises KeyError with the reason from the file. The full API is in ../README.md.

Test: python3 -m unittest lib/python/test_quran_text.py from the repo root.