Skip to main content

A library to deal with Quran Ayas

Project description

قارئ القرآن الكريم - Quran Reader

نظام الاستعلام عن بيانات القرءان الكريم بسهولة.

🚀 الاستخدام

قراءة البيانات

from quran_reader import QuranReader

# تحميل قاعدة البيانات
reader = QuranReader()

أ) قراءة آية كاملة

ayah = reader.get_ayah(surah_number=1, ayah_number=1)
print(ayah)
# بِسْمِ اللَّهِ الرَّحْمَٰنِ الرَّحِيمِ

ب) قراءة كلمة محددة

# الكلمة الأولى (index 0)
word = reader.get_word_at_index(surah_number=1, ayah_number=1, word_index=0)
print(word)
# بِسْمِ

# الكلمة الثانية (index 1)
word = reader.get_word_at_index(surah_number=1, ayah_number=1, word_index=1)
print(word)
# اللَّهِ

ج) معلومات عن سورة

info = reader.get_surah_info(surah_number=1)
print(info)
# {'surah_number': 1, 'ayat_count': 7, 'ayat_numbers': [1, 2, 3, 4, 5, 6, 7]}

د) طباعة آية مع أرقام الكلمات

reader.print_ayah(surah_number=1, ayah_number=1, show_word_indices=True)

# النتيجة:
# ============================================================
# السورة 1 - الآية 1
# ============================================================
# 
# [0] بِسْمِ
# [1] اللَّهِ
# [2] الرَّحْمَٰنِ
# [3] الرَّحِيمِ
# 
# عدد الكلمات: 4
# ============================================================

هـ) قراءة كل آيات سورة

ayat = reader.get_all_ayat_in_surah(surah_number=1)
for ayah_num, ayah_text in ayat.items():
    print(f"{ayah_num}. {ayah_text}")

و) البحث في آية

found = reader.search_in_ayah(
    surah_number=1, 
    ayah_number=1, 
    search_text="الرَّحْمَٰنِ"
)
print(found)  # True

ز) عدد الكلمات في آية

count = reader.get_word_count(surah_number=1, ayah_number=1)
print(count)  # 4

📝 الدوال المتاحة

الدالة الوصف
get_ayah(surah, ayah) الحصول على آية كاملة
get_word_at_index(surah, ayah, index) الحصول على كلمة محددة
get_surah_info(surah) معلومات عن السورة
get_all_ayat_in_surah(surah) كل آيات السورة
search_in_ayah(surah, ayah, text) البحث في آية
get_word_count(surah, ayah) عدد كلمات الآية
print_ayah(surah, ayah, show_indices) طباعة منسقة

🎯 أمثلة عملية

مثال 2: استعراض سورة كاملة مع التحليل

reader = QuranReader()

# قراءة كل آيات الفاتحة
ayat = reader.get_all_ayat_in_surah(1)

for ayah_num, ayah_text in ayat.items():
    print(f"\n{'='*60}")
    print(f"الآية {ayah_num}: {ayah_text}")
    print('='*60)

⚙️ متطلبات التشغيل

  • Python 3.6+
  • لا توجد مكتبات خارجية مطلوبة (استخدام المكتبات القياسية فقط)

📦 الملفات

  • quran_reader.py - قراءة والاستعلام عن البيانات
  • quran.json - قاعدة البيانات (يتم إنشاؤها)

💡 ملاحظات

  • أرقام الآيات والكلمات تبدأ من 1 (ليس من 0)
  • لكن الـ word_index يبدأ من 0 (لأنه index في Python)
  • يتم تنظيف المسافات الزائدة تلقائياً
  • يدعم Unicode كامل للنصوص العربية

✅ التثبيت

pip install quran-ayas

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quran_ayas-0.1.3.tar.gz (281.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quran_ayas-0.1.3-py3-none-any.whl (296.8 kB view details)

Uploaded Python 3

File details

Details for the file quran_ayas-0.1.3.tar.gz.

File metadata

  • Download URL: quran_ayas-0.1.3.tar.gz
  • Upload date:
  • Size: 281.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for quran_ayas-0.1.3.tar.gz
Algorithm Hash digest
SHA256 9926e94519bc7380f587fe5b814954139f640033ce7c3d40f1dc85f6f467ca20
MD5 7a8228506d44711566788364f83bc623
BLAKE2b-256 5d7bd525e7c4d905af2413507e375bca18d560d2790529aa2136a26e2dd7d67c

See more details on using hashes here.

File details

Details for the file quran_ayas-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: quran_ayas-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 296.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for quran_ayas-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d65e3064e9c8bbc4c3081c3d15945afddf86308d230f082ce448fd5d8af9408c
MD5 543dab2fabeaadfbf6d52554af067041
BLAKE2b-256 37b486b8031f736e471ea397b832baec6efcd1b83bdb84a03127694a841ab1d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page