IslamSDK Quran module with Quranic texts, utilities, and local database.
Project description
PyIslamSDK-Quran
🚀 هوية المشروع والإصدارات
| نوع الشارة | كود Markdown |
|---|---|
| إصدار PyPI | |
| إصدار GitHub | |
| وسم GitHub | |
| الرخصة | |
| حالة PyPI |
📊 الإحصائيات والتنزيلات
| نوع الشارة | كود Markdown |
|---|---|
| إجمالي التنزيلات (Pepy) | |
| التنزيلات الشهرية (Pepy) | |
| التنزيلات الأسبوعية (Pepy) | |
| تنزيلات PyPI (يومي) | |
| تنزيلات PyPI (أسبوعي) | |
| تنزيلات PyPI (شهري) |
🛠️ النشاط والتطوير
| نوع الشارة | كود Markdown |
|---|---|
| آخر تحديث | |
| نشاط الالتزامات (سنوي) | |
| المساهمون | |
| حجم المستودع | |
| حجم الكود | |
| اللغة الأساسية | |
| عدد اللغات |
✨ الجودة والاختبارات
| نوع الشارة | كود Markdown |
|---|---|
| حالة البناء | |
| تغطية الاختبارات | |
| جودة الكود | |
| الكتابة (Typing) | |
| أنواع PyPI |
🐍 البيئة والتوافق
| نوع الشارة | كود Markdown |
|---|---|
| إصدارات Python | |
| تطبيق PyPI | |
| عجلة PyPI | |
| تنسيق PyPI |
🤝 المجتمع والتواصل الاجتماعي
| نوع الشارة | كود Markdown |
|---|---|
| نجوم GitHub | |
| تفريعات GitHub | |
| متابعو GitHub | |
| متابعو المنظمة | |
| مناقشات GitHub |
🛠️ الدعم والصيانة
| نوع الشارة | كود Markdown |
|---|---|
| المشكلات المفتوحة | |
| المشكلات المغلقة | |
| طلبات السحب المفتوحة | |
| طلبات السحب المغلقة | |
| المعالم (Milestones) |
PyIslamSDK-Quran هي حزمة Python لتوفير وصول سهل إلى بيانات القرآن الصوتية والقراءات والمعلومات المرتبطة. تعتمد على المكتبة القياسية فقط ولا تحتاج إلى تبعيات خارجية.
التثبيت
pip install PyIslamSDK-Quran
بداية سريعة / أمثلة الاستخدام
تتيح لك الوحدة audios استرجاع معلومات عن القراء (الروايات) وخوادم الصوت.
الاستيراد والتهيئة
from pyislamsdk_quran.audios import AudioConfig
# إنشاء كائن لسورة الفاتحة (رقم ١) مع قارئ محدد باللغة العربية
audio = AudioConfig(surah_number=1, reciter_ar="عبدالباسط عبدالصمد")
الحصول على معلومات الرواية
# استرجاع تفاصيل الرواية (يمكن تحديد اللغة: 'ar' أو 'en')
rewaya_info = audio.get_rewaya(lang="ar")
print(rewaya_info)
# الناتج: {"status": True, "data": [...]} أو {"status": False, "error": ...}
الوصول إلى معلومات الخادم (السيرفر)
الصنف الداخلي Servers يوفر دوالاً للحصول على روابط الخوادم الصوتية.
# إنشاء كائن من الصنف Servers (مرتبط بنفس تهيئة الصوت)
servers = audio.Servers()
# الحصول على جميع الخوادم المتاحة (لكل السور/القراء)
all_servers = servers.get_all_servers()
print(all_servers)
# الحصول على الخادم الخاص بالسورة التي تم تهيئتها (سورة ١)
specific_server = servers.get_server()
print(specific_server)
كل دالة ترجع قاموسًا (dictionary) يحتوي على مفتاح status (منطقي) وإما data (عند النجاح) أو error (عند الفشل).
المتطلبات
· Python 3.9 أو أحدث (يستخدم مكتبة zoneinfo القياسية؛ بالنسبة لـ Python 3.8 قد تحتاج إلى حزمة backports.zoneinfo).
الترخيص
MIT - شركة إينوسوفت (InnoSoft Company)
PyIslamSDK-Quran (English)
A Python SDK for Quranic audio, recitations, and related Islamic data. This package provides an easy-to-use interface to access Quran audio files, reciter information, and server details — with zero external dependencies (uses only Python standard library).
View on GitHub | View on PyPI
Installation
pip install PyIslamSDK-Quran
Quick Start / Usage Examples
The audios module allows you to retrieve information about Quran reciters (rewaya) and audio servers.
Import and initialize
from pyislamsdk_quran.audios import AudioConfig
# Create an instance for Surah Al-Fatiha (surah 1) with a specific reciter (Arabic name)
audio = AudioConfig(surah_number=1, reciter_ar="عبدالباسط عبدالصمد")
Get recitation (rewaya) information
# Retrieve rewaya details in Arabic (or specify 'en' for English)
rewaya_info = audio.get_rewaya(lang="ar")
print(rewaya_info)
# Expected output: {"status": True, "data": [...]} or {"status": False, "error": ...}
Access server information
The Servers inner class provides methods to get audio server URLs.
# Create an instance of the Servers class (attached to the same audio configuration)
servers = audio.Servers()
# Get all available servers (for all surahs/reciters)
all_servers = servers.get_all_servers()
print(all_servers)
# Get the specific server for the surah you initialized (surah 1)
specific_server = servers.get_server()
print(specific_server)
Each method returns a dictionary with a status key (boolean) and either data (on success) or error (on failure).
Requirements
· Python 3.9 or later (uses standard library zoneinfo; for Python 3.8 you may need the backports.zoneinfo package).
License
MIT - InnoSoft Company
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyislamsdk_quran-0.0.1.tar.gz.
File metadata
- Download URL: pyislamsdk_quran-0.0.1.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5a5939aa97b8cf3abf8c017bb71e580037a524989a5e4e45640da3039e223d1e
|
|
| MD5 |
f2966b2f5f2537c2f4e0142379b253fd
|
|
| BLAKE2b-256 |
0b9993eb5a424fb56289c940c498d3f6edcdd89d825c370c117c0e01c411b4e7
|
File details
Details for the file pyislamsdk_quran-0.0.1-py3-none-any.whl.
File metadata
- Download URL: pyislamsdk_quran-0.0.1-py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b9ae4b5592bc09edc6ab8490144f5a5150b0a296c77526166f48b085faf800b2
|
|
| MD5 |
6c67652511672df8d8393857fde04edc
|
|
| BLAKE2b-256 |
9f0a80d950d7471fc8f94ab40ffd35ee564c3ca3afb8cd4259c4ec8c66e5a7ef
|