Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (7.4%) to scientific vocabulary
Repository
Utility to retrieve Quranic text in a fast and flexible way
Basic Info
- Host: GitHub
- Owner: kabikaj
- License: mit
- Language: Python
- Default Branch: main
- Size: 1.59 MB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
qran
Quran structured text API.
Python package to extract Quranic text in graphemic and archigraphemic representations, different Quranic encodings and Latin transliteration. The package works as a an API for the stuctured Quran.
This package can be very helpful for semiautomating the transcription of old Quranic manuscripts or fast lookups of script and typographic analysis.
Installation
bash
pip install qran
Usage
As a python library
```python from qran import get_text, Index
text = gettext( ... iniindex=Index(sura=1, verse=1, word=4, block=2), ... endindex=Index(sura=1, verse=2, word=2, block=-1), ... args={"blocks": True}, ... ) ... for graphemear, grapheme, lt, archigraphemear, arhigraphemelt in text: ... print(graphemear, grapheme, lt, archigraphemear, arhigrapheme_lt) ...
لرَّ LRᵚᵃ لر LR 1:1:4:2 حِيمِ GᵢB₂Mᵢ حٮم GBM 1:1:4:3 ا A ا A 1:2:1:1 لْحَمْدُ LᵒGᵃMᵒDᵘ لحمد LGMD 1:2:1:2 لِلَّهِ LᵢLᵚᵃHᵢ لله LLH 1:2:2:1 ```
Alternatively, you can use a tuple of integers instead of an Index object:
```python
text = gettext( ... iniindex=(1, 1, 4, 2), ... end_index=(1, 2, 2, -1), ... args={"blocks": True}, ... ) ```
As a unix-like command:
bash
$ qran 1:1:4:2-1:2:2 --blocks
لرَّ LRᵚᵃ لر LR 1:1:4:2
حِيمِ GᵢB₂Mᵢ حٮم GBM 1:1:4:3
ا A ا A 1:2:1:1
لْحَمْدُ LᵒGᵃMᵒDᵘ لحمد LGMD 1:2:1:2
لِلَّهِ LᵢLᵚᵃHᵢ لله LLH 1:2:2:1
License
This project is licensed under the MIT License for its source code.
It includes Quran text from the Tanzil Project, which is licensed under the Creative Commons Attribution 3.0 License.
© 2007–2021 Tanzil Project. The text is unmodified and used under Tanzil's terms of use: http://tanzil.net/docs/license
Author
Alicia González Martínez
Owner
- Login: kabikaj
- Kind: user
- Location: Hamburg
- Company: Universität Hamburg
- Website: https://www.linkedin.com/in/alicia-gonz%C3%A1lez-mart%C3%ADnez-8a72b8a5/
- Repositories: 15
- Profile: https://github.com/kabikaj
Alicia González Martínez Computational linguist and python developer
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Gonzalez Martinez
given-names: Alicia
orcid: https://orcid.org/0000-0001-6980-8735
title: "qran-app"
version: 1.0.1
identifiers:
- type: doi
value: 10.5281/zenodo.16282011
date-released: 2025-07-21
GitHub Events
Total
- Push event: 1
- Public event: 1
Last Year
- Push event: 1
- Public event: 1
Packages
- Total packages: 1
-
Total downloads:
- pypi 33 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 1
pypi.org: qran
Quran text API
- Homepage: https://qran-app.onrender.com/
- Documentation: https://qran.readthedocs.io/
- License: mit
-
Latest release: 1.0.1
published 8 months ago
Rankings
Maintainers (1)
Dependencies
- orjson *
- pydantic *