Skip to main content

IslamSDK Quran module with Quranic texts, utilities, and local database.

Project description

PyIslamSDK-Quran


🚀 هوية المشروع والإصدارات

نوع الشارة كود Markdown
إصدار PyPI PyPI Version
إصدار GitHub GitHub Release
وسم GitHub GitHub Tag
الرخصة License: MIT
حالة PyPI PyPI Status

📊 الإحصائيات والتنزيلات

نوع الشارة كود Markdown
إجمالي التنزيلات (Pepy) Total Downloads
التنزيلات الشهرية (Pepy) Monthly Downloads
التنزيلات الأسبوعية (Pepy) Weekly Downloads
تنزيلات PyPI (يومي) PyPI Downloads
تنزيلات PyPI (أسبوعي) PyPI Downloads
تنزيلات PyPI (شهري) PyPI Downloads

🛠️ النشاط والتطوير

نوع الشارة كود Markdown
آخر تحديث GitHub last commit
نشاط الالتزامات (سنوي) GitHub commit activity
المساهمون GitHub contributors
حجم المستودع GitHub repo size
حجم الكود GitHub code size in bytes
اللغة الأساسية GitHub top language
عدد اللغات GitHub language count

✨ الجودة والاختبارات

نوع الشارة كود Markdown
حالة البناء Build Status
تغطية الاختبارات Coverage
جودة الكود Code Quality
الكتابة (Typing) Typing
أنواع PyPI PyPI - Types

🐍 البيئة والتوافق

نوع الشارة كود Markdown
إصدارات Python Python Versions
تطبيق PyPI PyPI Implementation
عجلة PyPI PyPI Wheel
تنسيق PyPI PyPI Format

🤝 المجتمع والتواصل الاجتماعي

نوع الشارة كود Markdown
نجوم GitHub GitHub stars
تفريعات GitHub GitHub forks
متابعو GitHub GitHub watchers
متابعو المنظمة GitHub followers
مناقشات GitHub GitHub Discussions

🛠️ الدعم والصيانة

نوع الشارة كود Markdown
المشكلات المفتوحة GitHub issues
المشكلات المغلقة GitHub issues-closed
طلبات السحب المفتوحة GitHub pull requests
طلبات السحب المغلقة GitHub pull requests-closed
المعالم (Milestones) GitHub milestones

PyIslamSDK-Quran هي حزمة Python لتوفير وصول سهل إلى بيانات القرآن الصوتية والقراءات والمعلومات المرتبطة. تعتمد على المكتبة القياسية فقط ولا تحتاج إلى تبعيات خارجية.

عرض على GitHub | عرض على PyPI


التثبيت

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

pyislamsdk_quran-0.0.1.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

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

pyislamsdk_quran-0.0.1-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

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

Hashes for pyislamsdk_quran-0.0.1.tar.gz
Algorithm Hash digest
SHA256 5a5939aa97b8cf3abf8c017bb71e580037a524989a5e4e45640da3039e223d1e
MD5 f2966b2f5f2537c2f4e0142379b253fd
BLAKE2b-256 0b9993eb5a424fb56289c940c498d3f6edcdd89d825c370c117c0e01c411b4e7

See more details on using hashes here.

File details

Details for the file pyislamsdk_quran-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pyislamsdk_quran-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b9ae4b5592bc09edc6ab8490144f5a5150b0a296c77526166f48b085faf800b2
MD5 6c67652511672df8d8393857fde04edc
BLAKE2b-256 9f0a80d950d7471fc8f94ab40ffd35ee564c3ca3afb8cd4259c4ec8c66e5a7ef

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