islamic-content-sdk 1.0.0__py3-none-any.whl

islamic_content_sdk/__init__.py

@@ -0,0 +1,3 @@
+from .client import IslamicContentSdk
+
+__all__ = ["IslamicContentSdk"]

islamic_content_sdk/client.py

@@ -0,0 +1,15 @@
+from .services.quranenc import QuranencService
+from .services.hadeethenc import HadeethencService
+from .services.islamhouse import IslamhouseService
+from .services.risalat_al_haramain import RisalatAlHaramainService
+from .services.bayan_al_islam import BayanAlIslamService
+from .services.al_montaka import AlMontakaService
+
+class IslamicContentSdk:
+    def __init__(self):
+        self.quranenc = QuranencService()
+        self.hadeethenc = HadeethencService()
+        self.islamhouse = IslamhouseService()
+        self.risalatAlHaramain = RisalatAlHaramainService()
+        self.bayanAlIslam = BayanAlIslamService()
+        self.alMontaka = AlMontakaService()

islamic_content_sdk/services/__init__.py

@@ -0,0 +1 @@
+# Services package init

islamic_content_sdk/services/al_montaka.py

@@ -0,0 +1,129 @@
+from urllib.parse import urlencode
+from .base import BaseService
+
+class AlMontakaContentsService(BaseService):
+    def __init__(self, baseurl: str):
+        super().__init__()
+        self.baseurl = baseurl
+
+    def comments(self, content_id: int):
+        url = f"{self.baseurl}/comments?content_id={content_id}"
+        return self._request(url)
+
+    def addComment(self, content_id: int, comment: str):
+        url = f"{self.baseurl}/comment"
+        body = {
+            "content_id": str(content_id),
+            "comment": comment
+        }
+        return self._request(
+            url,
+            "POST",
+            body,
+            {"Content-Type": "application/x-www-form-urlencoded"}
+        )
+
+    def content(self, categories: list):
+        query_params = {}
+        for index, cat in enumerate(categories):
+            query_params[f"category[{index}]"] = str(cat)
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/content?{query}"
+        return self._request(url)
+
+
+class AlMontakaLookupsService(BaseService):
+    def __init__(self, baseurl: str):
+        super().__init__()
+        self.baseurl = baseurl
+
+    def ageGroups(self):
+        url = f"{self.baseurl}/age-groups"
+        return self._request(url)
+
+    def categories(self, params: dict):
+        query_params = {
+            "language_id": str(params["languageId"]),
+            "name_cont": params["nameCont"]
+        }
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/categories?{query}"
+        return self._request(url)
+
+    def entities(self, params: dict):
+        query_params = {
+            "language_id": str(params["languageId"]),
+            "name_cont": params["nameCont"]
+        }
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/entities?{query}"
+        return self._request(url)
+
+    def expertLevels(self, params: dict):
+        query_params = {
+            "language_id": str(params["languageId"]),
+            "name_cont": params["nameCont"]
+        }
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/expert-levels?{query}"
+        return self._request(url)
+
+    def ideologies(self, params: dict):
+        query_params = {
+            "language_id": str(params["languageId"]),
+            "name_cont": params["nameCont"],
+            "parent_id": str(params["parentId"])
+        }
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/ideologies?{query}"
+        return self._request(url)
+
+    def languages(self):
+        url = f"{self.baseurl}/languages"
+        return self._request(url)
+
+    def persons(self, params=None):
+        if params is None:
+            params = {}
+        query_params = {}
+        if params.get("nameCont"):
+            query_params["name_cont"] = params["nameCont"]
+        if params.get("page") is not None:
+            query_params["page"] = params["page"]
+        
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/persons?{query}"
+        return self._request(url)
+
+    def sections(self, params: dict):
+        query_params = {
+            "language_id": str(params["languageId"]),
+            "name_cont": params["nameCont"]
+        }
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/sections?{query}"
+        return self._request(url)
+
+    def tags(self, params: dict):
+        query_params = {
+            "language_id": str(params["languageId"]),
+            "name_cont": params["nameCont"]
+        }
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/tags?{query}"
+        return self._request(url)
+
+    def targetedGroups(self):
+        url = f"{self.baseurl}/targeted-groups"
+        return self._request(url)
+
+    def youtubeChannels(self):
+        url = f"{self.baseurl}/youtube-channels"
+        return self._request(url)
+
+
+class AlMontakaService:
+    def __init__(self):
+        self.baseurl = "https://content.mofeed.org/Api"
+        self.contents = AlMontakaContentsService(self.baseurl)
+        self.lookups = AlMontakaLookupsService(self.baseurl)

islamic_content_sdk/services/base.py

@@ -0,0 +1,41 @@
+import requests
+
+class BaseService:
+    def _request(self, url: str, method: str = "GET", body=None, custom_headers=None):
+        headers = {
+            "Content-Type": "application/json",
+            "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
+        }
+        if custom_headers:
+            headers.update(custom_headers)
+
+        options = {
+            "headers": headers
+        }
+
+        if body is not None:
+            content_type = headers.get("Content-Type", "")
+            if "application/x-www-form-urlencoded" in content_type:
+                options["data"] = body
+            elif isinstance(body, (dict, list)):
+                options["json"] = body
+            elif isinstance(body, str):
+                options["data"] = body
+            else:
+                options["data"] = body
+
+        try:
+            response = requests.request(method, url, **options)
+            if response.status_code < 200 or response.status_code >= 300:
+                raise Exception(f"API request failed with status {response.status_code}: {response.reason}")
+            
+            if not response.text:
+                return {}
+
+            try:
+                return response.json()
+            except ValueError:
+                return response.text
+        except Exception as error:
+            # Re-throw or format the error professionally
+            raise Exception(f"[IslamicContentSdk] {str(error)}")

islamic_content_sdk/services/bayan_al_islam.py

@@ -0,0 +1,71 @@
+import json
+from urllib.parse import urlencode, quote
+from .base import BaseService
+
+class BayanAlIslamService(BaseService):
+    def __init__(self):
+        super().__init__()
+        self.baseurl = "https://byenah.com"
+
+    def languagesList(self, language: str = "ar"):
+        url = f"{self.baseurl}/{language}/Api/languages/list"
+        return self._request(url)
+
+    def muslimList(self, language: str = "en"):
+        url = f"{self.baseurl}/{language}/Api/content/muslims/full_list"
+        return self._request(url)
+
+    def nonMuslimList(self, language: str = "en"):
+        url = f"{self.baseurl}/{language}/Api/content/non-muslims/full_list"
+        return self._request(url)
+
+    def singleContent(self, content_id: int, language: str = "en"):
+        url = f"{self.baseurl}/{language}/Api/single-content?id={content_id}"
+        return self._request(url)
+
+    def paginatedLanguages(self, params=None):
+        if params is None:
+            params = {}
+        language = params.get("language", "en")
+        query_params = {}
+        if params.get("name"):
+            query_params["name"] = params["name"]
+        if params.get("page") is not None:
+            query_params["page"] = params["page"]
+        
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/{language}/Api/paginated-languages?{query}"
+        return self._request(url)
+
+    def recentContents(self, params: dict):
+        language = params.get("language", "en")
+        query_params = {
+            "lang": params["lang"],
+            "init": str(params["init"]).lower()
+        }
+        if params.get("ids") and len(params["ids"]) > 0:
+            query_params["ids"] = json.dumps(params["ids"])
+
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/{language}/Api/recent-contents?{query}"
+        return self._request(url)
+
+    def lookups(self, language: str = "en"):
+        url = f"{self.baseurl}/{language}/Api/lookups"
+        return self._request(url)
+
+    def nameSearch(self, name: str, language: str = "ar"):
+        url = f"{self.baseurl}/{language}/Api/name_search?name={quote(name)}"
+        return self._request(url)
+
+    def availableLanguages(self, content_id: int, language: str = "ar"):
+        url = f"{self.baseurl}/{language}/Api/available_languages/{content_id}"
+        return self._request(url)
+
+    def contentTranslation(self, content_id: int, target_language: str, language: str = "en"):
+        url = f"{self.baseurl}/{language}/Api/content_translation/{content_id}?language={target_language}"
+        return self._request(url)
+
+    def attachmentsTranslation(self, content_id: int, target_language: str, language: str = "en"):
+        url = f"{self.baseurl}/{language}/Api/attachments_translation/{content_id}?language={target_language}"
+        return self._request(url)

islamic_content_sdk/services/hadeethenc.py

@@ -0,0 +1,43 @@
+from urllib.parse import urlencode
+from .base import BaseService
+
+class HadeethencService(BaseService):
+    def __init__(self):
+        super().__init__()
+        self.baseurl = "https://hadeethenc.com/api/v1"
+
+    def languages(self):
+        url = f"{self.baseurl}/languages"
+        return self._request(url)
+
+    def categories(self, language_code: str):
+        query = urlencode({"language": language_code})
+        url = f"{self.baseurl}/categories/list/?{query}"
+        return self._request(url)
+
+    def rootCategories(self, language_code: str):
+        query = urlencode({"language": language_code})
+        url = f"{self.baseurl}/categories/roots/?{query}"
+        return self._request(url)
+
+    def hadithsList(self, params: dict):
+        query_params = {"language": params["language"]}
+        if params.get("categoryId") is not None:
+            query_params["category_id"] = params["categoryId"]
+        if params.get("page") is not None:
+            query_params["page"] = params["page"]
+        if params.get("perPage") is not None:
+            query_params["per_page"] = params["perPage"]
+
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/hadeeths/list/?{query}"
+        return self._request(url)
+
+    def hadithDetails(self, params: dict):
+        query_params = {
+            "id": params["id"],
+            "language": params["language"]
+        }
+        query = urlencode(query_params)
+        url = f"{self.baseurl}/hadeeths/one/?{query}"
+        return self._request(url)

islamic_content_sdk/services/islamhouse.py

@@ -0,0 +1,191 @@
+from .base import BaseService
+
+class IslamhouseCategoriesAndTypesService(BaseService):
+    def __init__(self, baseurl: str):
+        super().__init__()
+        self.baseurl = baseurl
+
+    def allTypes(self, site_lang: str, content_lang: str):
+        url = f"{self.baseurl}/main/sitecontent/{site_lang}/{content_lang}/json"
+        return self._request(url)
+
+    def allCategories(self, language: str):
+        url = f"{self.baseurl}/categories/showall/{language}/json"
+        return self._request(url)
+
+    def categoriesTree(self, language: str):
+        url = f"{self.baseurl}/main/get-object-category-tree/{language}/json"
+        return self._request(url)
+
+    def childCategories(self, category_id: int, site_lang: str, content_lang: str):
+        url = f"{self.baseurl}/categories/viewcat/{category_id}/{site_lang}/{content_lang}/json"
+        return self._request(url)
+
+    def singleCategoryBasic(self, category_id: int, language: str):
+        url = f"{self.baseurl}/categories/viewitem/{category_id}/{language}/json"
+        return self._request(url)
+
+    def subCategories(self, category_id: int, language: str):
+        url = f"{self.baseurl}/main/get-sub-categories/{category_id}/{language}/json"
+        return self._request(url)
+
+    def categoryTypes(self, category_id: int, site_lang: str, content_lang: str):
+        url = f"{self.baseurl}/main/get-category-types-available/{category_id}/{site_lang}/{content_lang}/json"
+        return self._request(url)
+
+    def categoryLanguages(self, category_id: int, slang: str, language: str):
+        url = f"{self.baseurl}/main/get-category-source-languages/{category_id}/{slang}/{language}/json"
+        return self._request(url)
+
+
+class IslamhouseItemsService(BaseService):
+    def __init__(self, baseurl: str):
+        super().__init__()
+        self.baseurl = baseurl
+
+    def listItems(self, type: str, site_lang: str, slang: str, page: int = 1, limit: int = 25):
+        url = f"{self.baseurl}/main/{type}/{site_lang}/{slang}/{page}/{limit}/json"
+        return self._request(url)
+
+    def authorItems(self, author_id: int, slang: str, site_lang: str, content_lang: str, page: int = 1, limit: int = 20):
+        url = f"{self.baseurl}/main/get-author-items/{author_id}/{slang}/{site_lang}/{content_lang}/{page}/{limit}/json"
+        return self._request(url)
+
+    def categoryItems(self, category_id: int, slang: str, site_lang: str, content_lang: str, page: int = 1, limit: int = 20):
+        url = f"{self.baseurl}/main/get-category-items/{category_id}/{slang}/{site_lang}/{content_lang}/{page}/{limit}/json"
+        return self._request(url)
+
+    def latestItems(self, period: str, slang: str, site_lang: str, content_lang: str, page: int = 1, limit: int = 25):
+        url = f"{self.baseurl}/main/get-latest/{period}/{slang}/{site_lang}/{content_lang}/{page}/{limit}/json"
+        return self._request(url)
+
+    def highlightedItems(self, site_lang: str, content_lang: str):
+        url = f"{self.baseurl}/main/get-highlights/{site_lang}/{content_lang}/json"
+        return self._request(url)
+
+    def itemsCount(self, type: str, site_lang: str, content_lang: str):
+        url = f"{self.baseurl}/main/get-language-items-count/{type}/{site_lang}/{content_lang}/json"
+        return self._request(url)
+
+
+class IslamhouseItemService(BaseService):
+    def __init__(self, baseurl: str):
+        super().__init__()
+        self.baseurl = baseurl
+
+    def details(self, item_id: int, language: str):
+        url = f"{self.baseurl}/main/get-item/{item_id}/{language}/json"
+        return self._request(url)
+
+    def attachments(self, item_id: int):
+        url = f"{self.baseurl}/main/check-attachment/{item_id}/json"
+        return self._request(url)
+
+    def tree(self, item_id: int, language: str):
+        url = f"{self.baseurl}/main/get-item-tree/{item_id}/{language}/json"
+        return self._request(url)
+
+    def cardTranslations(self, item_id: int, language: str):
+        url = f"{self.baseurl}/main/get-item-card-translations/{item_id}/{language}/json"
+        return self._request(url)
+
+    def translations(self, item_id: int, language: str):
+        url = f"{self.baseurl}/main/get-item-translations/{item_id}/{language}/json"
+        return self._request(url)
+
+
+class IslamhouseAuthorsService(BaseService):
+    def __init__(self, baseurl: str):
+        super().__init__()
+        self.baseurl = baseurl
+
+    def list(self, params=None):
+        if params is None:
+            params = {}
+        kind = params.get("kind", "showall")
+        locale = params.get("locale", "showall")
+        sort = params.get("sort", "countdesc")
+        page = params.get("page", 1)
+        per_page = params.get("perPage", 20)
+
+        url = f"{self.baseurl}/main/get-authors-data/{kind}/{locale}/{sort}/{page}/{per_page}/json"
+        return self._request(url)
+
+    def details(self, author_id: int, language: str):
+        url = f"{self.baseurl}/main/get-author/{author_id}/{language}/json"
+        return self._request(url)
+
+    def cardTranslations(self, author_id: int, language: str):
+        url = f"{self.baseurl}/main/get-author-card-translations/{author_id}/{language}/json"
+        return self._request(url)
+
+    def availableTypes(self, author_id: int, site_lang: str, content_lang: str):
+        url = f"{self.baseurl}/main/get-author-types-avaliable/{author_id}/{site_lang}/{content_lang}/json"
+        return self._request(url)
+
+    def availableLocales(self, author_id: int, slang: str, language: str):
+        url = f"{self.baseurl}/main/get-author-available-languages/{author_id}/{slang}/{language}/json"
+        return self._request(url)
+
+
+class IslamhouseLanguagesService(BaseService):
+    def __init__(self, baseurl: str):
+        super().__init__()
+        self.baseurl = baseurl
+
+    def keys(self):
+        url = f"{self.baseurl}/languages/get-language-details/json"
+        return self._request(url)
+
+    def terms(self, language: str):
+        url = f"{self.baseurl}/languages/get-language-terms/{language}/json"
+        return self._request(url)
+
+    def availableLanguages(self, slang: str, language: str):
+        url = f"{self.baseurl}/main/get-available-languages/{slang}/{language}/json"
+        return self._request(url)
+
+
+class IslamhouseQuranService(BaseService):
+    def __init__(self, baseurl: str):
+        super().__init__()
+        self.baseurl = baseurl
+
+    def categories(self, language: str):
+        url = f"{self.baseurl}/quran/get-categories/{language}/json"
+        return self._request(url)
+
+    def singleCategory(self, category_id: int, language: str):
+        url = f"{self.baseurl}/quran/get-category/{category_id}/{language}/json"
+        return self._request(url)
+
+    def authorDetails(self, author_id: int, language: str):
+        url = f"{self.baseurl}/quran/get-author/{author_id}/{language}/json"
+        return self._request(url)
+
+    def authorRecitations(self, author_id: int, language: str):
+        url = f"{self.baseurl}/quran/get-author-recitations/{author_id}/{language}/json"
+        return self._request(url)
+
+    def suraDetails(self, sura_id: int, language: str):
+        url = f"{self.baseurl}/quran/get-sura/{sura_id}/{language}/json"
+        return self._request(url)
+
+    def suraRecitations(self, sura_id: int, language: str):
+        url = f"{self.baseurl}/quran/get-sura-recitations/{sura_id}/{language}/json"
+        return self._request(url)
+
+    def recitationDetails(self, recitation_id: int, language: str):
+        url = f"{self.baseurl}/quran/get-recitation/{recitation_id}/{language}/json"
+        return self._request(url)
+
+
+class IslamhouseService:
+    def __init__(self):
+        self.baseurl = "https://api3.islamhouse.com/v3/paV29H2gm56kvLPy"
+        self.categoriesAndTypes = IslamhouseCategoriesAndTypesService(self.baseurl)
+        self.items = IslamhouseItemsService(self.baseurl)
+        self.item = IslamhouseItemService(self.baseurl)
+        self.authors = IslamhouseAuthorsService(self.baseurl)
+        self.languages = IslamhouseLanguagesService(self.baseurl)
+        self.quran = IslamhouseQuranService(self.baseurl)

islamic_content_sdk/services/quranenc.py

@@ -0,0 +1,41 @@
+from .base import BaseService
+
+class QuranencService(BaseService):
+    def __init__(self):
+        super().__init__()
+        self.baseurl = "https://quranenc.com/api/v1"
+        self.audio_base_url = "https://d.quranenc.com/data/audio"
+
+    def translationList(self, params=None):
+        if params is None:
+            params = {}
+        
+        url = f"{self.baseurl}/translations/list"
+        if params.get("language"):
+            url += f"/{params['language']}"
+        if params.get("localization"):
+            url += f"?localization={params['localization']}"
+            
+        return self._request(url)
+
+    def translationSura(self, translation_key: str, sura_number: int):
+        url = f"{self.baseurl}/translation/sura/{translation_key}/{sura_number}"
+        return self._request(url)
+
+    def translationAya(self, translation_key: str, sura_number: int, aya_number: int):
+        url = f"{self.baseurl}/translation/aya/{translation_key}/{sura_number}/{aya_number}"
+        return self._request(url)
+
+    def ayaAudio(self, translation_key: str, sura_number: int, aya_number: int):
+        sura_3digits = str(sura_number).zfill(3)
+        aya_3digits = str(aya_number).zfill(3)
+        url = f"{self.audio_base_url}/{translation_key}/{sura_3digits}{aya_3digits}.mp3"
+        return {
+            "status": 200,
+            "file_url": url,
+            "content_type": "audio/mpeg"
+        }
+
+    def addNote(self, payload: dict):
+        url = f"{self.baseurl}/translations/note"
+        return self._request(url, "POST", payload)

islamic_content_sdk/services/risalat_al_haramain.py

@@ -0,0 +1,110 @@
+from urllib.parse import quote
+from .base import BaseService
+
+class RisalaContentsService(BaseService):
+    def __init__(self, baseurl: str, api_path: str):
+        super().__init__()
+        self.baseurl = baseurl
+        self.api_path = api_path
+
+    def getFullContents(self, params=None):
+        if params is None:
+            params = {}
+        language = params.get("language", "en")
+        lang = params.get("lang", "en")
+        url = f"{self.baseurl}/{language}/{self.api_path}/get_full_contents?lang={lang}"
+        return self._request(url)
+
+    def getContents(self, params=None):
+        if params is None:
+            params = {}
+        language = params.get("language", "en")
+        lang = params.get("lang", "en")
+        url = f"{self.baseurl}/{language}/{self.api_path}/content?lang={lang}"
+        return self._request(url)
+
+    def singleContent(self, content_id: int, language: str = "en"):
+        url = f"{self.baseurl}/{language}/{self.api_path}/single-content?id={content_id}"
+        return self._request(url)
+
+    def nameSearch(self, name: str, language: str = "ar"):
+        url = f"{self.baseurl}/{language}/{self.api_path}/name_search?name={quote(name)}"
+        return self._request(url)
+
+    def availableLanguages(self, content_id: int, language: str = "ar"):
+        url = f"{self.baseurl}/{language}/{self.api_path}/available_languages/{content_id}"
+        return self._request(url)
+
+    def contentTranslation(self, content_id: int, target_language: str, language: str = "en"):
+        url = f"{self.baseurl}/{language}/{self.api_path}/content_translation/{content_id}?language={target_language}"
+        return self._request(url)
+
+
+class RisalaIslamicContentService(BaseService):
+    def __init__(self, baseurl: str, api_path: str):
+        super().__init__()
+        self.baseurl = baseurl
+        self.api_path = api_path
+
+    def fatwas(self, params=None):
+        if params is None:
+            params = {}
+        language = params.get("language", "en")
+        lang = params.get("lang", "ar")
+        is_featured = params.get("isFeatured", 1)
+        url = f"{self.baseurl}/{language}/{self.api_path}/fatwas?lang={lang}&is_featured={is_featured}"
+        return self._request(url)
+
+    def hadeeths(self, params=None):
+        if params is None:
+            params = {}
+        language = params.get("language", "en")
+        lang = params.get("lang", "ar")
+        is_featured = params.get("isFeatured", 1)
+        url = f"{self.baseurl}/{language}/{self.api_path}/hadeeths?lang={lang}&is_featured={is_featured}"
+        return self._request(url)
+
+    def quran(self, params=None):
+        if params is None:
+            params = {}
+        language = params.get("language", "en")
+        lang = params.get("lang", "ar")
+        is_featured = params.get("isFeatured", 1)
+        url = f"{self.baseurl}/{language}/{self.api_path}/quran?lang={lang}&is_featured={is_featured}"
+        return self._request(url)
+
+
+class RisalaSearchService(BaseService):
+    def __init__(self, baseurl: str, api_path: str):
+        super().__init__()
+        self.baseurl = baseurl
+        self.api_path = api_path
+
+    def contents(self, query: str, language: str = "en"):
+        url = f"{self.baseurl}/{language}/{self.api_path}/search?query={quote(query)}"
+        return self._request(url)
+
+
+class RisalaLookupsService(BaseService):
+    def __init__(self, baseurl: str, api_path: str):
+        super().__init__()
+        self.baseurl = baseurl
+        self.api_path = api_path
+
+    def languages(self, language: str = "en", api_key: str = "A7X9G2L5M8P4T1C3D6V0KJQZRYBWFNSHEUO9682XLMTGVDPKJHQC7R5ZYA1B3W4F"):
+        url = f"{self.baseurl}/{language}/{self.api_path}/langs?api_key={api_key}"
+        return self._request(url)
+
+    def contentTypes(self, language: str = "en"):
+        url = f"{self.baseurl}/{language}/{self.api_path}/content-types"
+        return self._request(url)
+
+
+class RisalatAlHaramainService:
+    def __init__(self):
+        self.baseurl = "https://risala.prh.gov.sa"
+        self.api_path = "Api"
+        self.contents = RisalaContentsService(self.baseurl, self.api_path)
+        self.islamicContent = RisalaIslamicContentService(self.baseurl, self.api_path)
+        self.search = RisalaSearchService(self.baseurl, self.api_path)
+        self.lookups = RisalaLookupsService(self.baseurl, self.api_path)

islamic_content_sdk-1.0.0.dist-info/METADATA

@@ -0,0 +1,483 @@
+Metadata-Version: 2.1
+Name: islamic-content-sdk
+Version: 1.0.0
+Summary: An integrated and easy-to-use software library to fetch authentic Islamic content (Holy Quran and Hadith) in multiple languages.
+Home-page: https://github.com/2yousefreda/islamic-content-sdk-npm
+Author: The Association for Multi-lingual Islamic Content
+Author-email: info@islamiccontent.sa
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: ISC License (ISCL)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: requests >=2.25.0
+
+# Islamic Content SDK (Python)
+
+An integrated and easy-to-use software library for Python developers to fetch authentic Islamic content (The Holy Qur'an and Hadith) in multiple languages directly from official sources.
+
+This project is developed for [The Association for Multi-lingual Islamic Content](https://islamiccontent.sa/).
+
+---
+
+## Services Overview
+
+This SDK aggregates content from multiple major multi-lingual Islamic platforms:
+
+- **QuranEnc (`quranenc`)**: Quran Translations, suras, verses, and audios.
+- **HadeethEnc (`hadeethenc`)**: Hadith collections, category trees, and grades.
+- **IslamHouse (`islamhouse`)**: Multi-lingual books, articles, audios, fatwas, and author details.
+- **Risalat Al-Haramain (`risalatAlHaramain`)**: Platform content, Fatwas, Quran recitations, and Hadiths.
+- **Bayan Al Islam (`bayanAlIslam`)**: Educational booklets and resources tailored for Muslims and Non-Muslims.
+- **Al Montaka (`alMontaka`)**: Structured lookups, categories, content filters, and community comments.
+
+---
+
+## Installation
+
+Install the package via pip:
+
+```bash
+pip install islamic-content-sdk
+```
+
+## Usage
+
+### Initializing the SDK
+
+```python
+from islamic_content_sdk import IslamicContentSdk
+
+sdk = IslamicContentSdk()
+```
+
+---
+
+## Detailed Service Methods Reference
+
+Below is a complete guide on how to interact with every single method and option available in the SDK.
+
+### Quran Source (QuranEnc API)
+
+**API Documentation Link:** [QuranEnc API](https://quranenc.com/en/home/api/)
+
+```python
+# 1. Get available translations list on the platform
+translations = sdk.quranenc.translationList({
+    "language": "es",      # Optional: Filter list by language code
+    "localization": "ar"   # Optional: Localize names in the response
+})
+
+# 2. Translate an entire sura (Al-Fatiha in Spanish)
+sura = sdk.quranenc.translationSura("spanish_montada_eu", 1)
+
+# 3. Translate a specific verse (Ayah 1 of Sura 1)
+aya = sdk.quranenc.translationAya("spanish_montada_eu", 1, 1)
+
+# 4. Get the audio MP3 file details for a specific verse
+audio = sdk.quranenc.ayaAudio("chinese_suliman", 1, 1)
+# Returns: {"status": 200, "file_url": "...", "content_type": "audio/mpeg"}
+
+# 5. Submit translation feedback/note (POST request)
+note_response = sdk.quranenc.addNote({
+    "sura": 1,
+    "aya": 1,
+    "name": "QA Tester",
+    "email": "qa@example.com",
+    "note": "Test note from SDK automated test suite",
+    "translation_key": "spanish_montada_eu",
+    "source": "sdk_test",
+    "version": "1.0.0",
+    "suggested_translation": "Suggested text" # Optional
+})
+```
+
+---
+
+### Hadith Source (HadeethEnc API)
+
+**API Documentation Link:** [HadeethEnc API](https://documenter.getpostman.com/view/5211979/TVev3j7q#intro)
+
+```python
+# 1. Get available languages in the encyclopedia
+languages = sdk.hadeethenc.languages()
+
+# 2. Get all categories of Hadith translated in a specific language
+categories = sdk.hadeethenc.categories("en")
+
+# 3. Get main (root) categories of Hadith in English
+root_categories = sdk.hadeethenc.rootCategories("en")
+
+# 4. List Hadiths under a category with pagination
+hadiths = sdk.hadeethenc.hadithsList({
+    "language": "en",
+    "categoryId": 1,  # Optional: Category ID
+    "page": 1,        # Optional: Page number
+    "perPage": 20     # Optional: Number of items per page
+})
+
+# 5. Get full explanation, translations, and grade of a specific Hadith by ID
+hadith = sdk.hadeethenc.hadithDetails({
+    "id": 2962,
+    "language": "ar"
+})
+```
+
+---
+
+### IslamHouse Source (IslamHouse v3 API)
+
+**API Documentation Link:** [IslamHouse API Docs](https://documenter.getpostman.com/view/7929737/TzkyMfPc)
+
+```python
+# ==========================================
+# 1. Categories & Types (categoriesAndTypes)
+# ==========================================
+
+# Core material types (videos, books, fatwas, etc.)
+types = sdk.islamhouse.categoriesAndTypes.allTypes("ar", "ar") # siteLang, contentLang
+
+# Get all categories in the database
+all_categories = sdk.islamhouse.categoriesAndTypes.allCategories("ar")
+
+# Complete category hierarchy tree
+tree = sdk.islamhouse.categoriesAndTypes.categoriesTree("ar")
+
+# Subcategories of a category with content lang localization
+child_cats = sdk.islamhouse.categoriesAndTypes.childCategories(1, "ar", "ar") # categoryId, siteLang, contentLang
+
+# Basic details of a category by ID
+single_category = sdk.islamhouse.categoriesAndTypes.singleCategoryBasic(1, "ar")
+
+# Subcategories with nested children
+sub_categories = sdk.islamhouse.categoriesAndTypes.subCategories(1, "ar")
+
+# Available material types under a specific category ID
+category_types = sdk.islamhouse.categoriesAndTypes.categoryTypes(1, "ar", "ar")
+
+# Available languages for materials within a category ID
+category_langs = sdk.islamhouse.categoriesAndTypes.categoryLanguages(1, "ar", "ar") # id, slang, language
+
+# ==========================================
+# 2. Items Listings (items)
+# ==========================================
+
+# List materials by type (e.g. "books", "videos", "audios") and language
+items = sdk.islamhouse.items.listItems("books", "ar", "ar", 1, 25) # type, siteLang, slang, page, limit
+
+# List materials published by a specific author ID
+author_items = sdk.islamhouse.items.authorItems(1, "ar", "ar", "ar", 1, 20) # authorId, slang, siteLang, contentLang, page, limit
+
+# List materials categorized under a category ID
+cat_items = sdk.islamhouse.items.categoryItems(1, "ar", "ar", "ar", 1, 20) # categoryId, slang, siteLang, contentLang, page, limit
+
+# List latest items by period (e.g., "week", "month")
+latest_items = sdk.islamhouse.items.latestItems("week", "ar", "ar", "ar", 1, 25) # period, slang, siteLang, contentLang, page, limit
+
+# Highlighted featured items on the homepage
+highlights = sdk.islamhouse.items.highlightedItems("ar", "ar") # siteLang, contentLang
+
+# Get the total count of items available for a specific type
+items_count = sdk.islamhouse.items.itemsCount("books", "ar", "ar") # type, siteLang, contentLang
+
+# ==========================================
+# 3. Single Item Details (item)
+# ==========================================
+
+# Details, metadata, and description of a single item
+item_details = sdk.islamhouse.item.details(228065, "ar")
+
+# List downloadable media/PDF attachments for an item
+attachments = sdk.islamhouse.item.attachments(228065)
+
+# Category tree path leading to this item
+item_tree = sdk.islamhouse.item.tree(228065, "ar")
+
+# Translation card details of the item
+item_card_trans = sdk.islamhouse.item.cardTranslations(228065, "ar")
+
+# Other translation languages available for this item
+translations = sdk.islamhouse.item.translations(228065, "ar")
+
+# ==========================================
+# 4. Authors and Publishers (authors)
+# ==========================================
+
+# List authors/sources with filter and sort parameters
+authors = sdk.islamhouse.authors.list({
+    "kind": "author",     # Optional: "showall" | "author" | "source"
+    "locale": "ar",       # Optional: "showall" | language code
+    "sort": "countdesc",  # Optional
+    "page": 1,            # Optional
+    "perPage": 10         # Optional
+})
+
+# Specific author details by ID
+author_details = sdk.islamhouse.authors.details(1, "ar")
+
+# Translation card details of an author
+author_card = sdk.islamhouse.authors.cardTranslations(1, "ar")
+
+# Material types available for an author
+author_types = sdk.islamhouse.authors.availableTypes(1, "ar", "ar")
+
+# Languages available for an author
+author_langs = sdk.islamhouse.authors.availableLocales(1, "ar", "ar")
+
+# ==========================================
+# 5. Languages & Terms (languages)
+# ==========================================
+
+# Details of all supported languages on the platform
+lang_keys = sdk.islamhouse.languages.keys()
+
+# Interface translation terms for localization
+terms = sdk.islamhouse.languages.terms("ar")
+
+# Available languages relative to another
+avail_langs = sdk.islamhouse.languages.availableLanguages("ar", "ar")
+
+# ==========================================
+# 6. Holy Quran Recitations (quran)
+# ==========================================
+
+# Quran recitation categories (reciters, sections)
+quran_categories = sdk.islamhouse.quran.categories("ar")
+
+# Basic details of a Quran category
+quran_category = sdk.islamhouse.quran.singleCategory(1, "ar")
+
+# Details about a specific reciter
+reciter_details = sdk.islamhouse.quran.authorDetails(1, "ar")
+
+# Recitations list of a specific reciter
+recitations = sdk.islamhouse.quran.authorRecitations(1, "ar")
+
+# Detailed info of a specific Quran Surah
+sura_details = sdk.islamhouse.quran.suraDetails(1, "ar")
+
+# Audio recordings of a specific Surah by various reciters
+sura_recitations = sdk.islamhouse.quran.suraRecitations(1, "ar")
+
+# Details of a specific Quran recitation by ID
+recitation = sdk.islamhouse.quran.recitationDetails(228065, "ar")
+```
+
+---
+
+### Risalat Al-Haramain Source (Risalat Al-Haramain API)
+
+**API Documentation Link:** [Risalat Al-Haramain API](https://risala.prh.gov.sa/en/Api/content)
+
+```python
+# ==========================================
+# 1. Platform Contents (contents)
+# ==========================================
+
+# Get full content of the platform in a specific language
+full_contents = sdk.risalatAlHaramain.contents.getFullContents({
+    "language": "en", # Optional: URL language path (default: "en")
+    "lang": "en"     # Optional: Query parameter language (default: "en")
+})
+
+# Retrieve contents with optional parameters
+contents = sdk.risalatAlHaramain.contents.getContents({
+    "language": "en",
+    "lang": "en"
+})
+
+# Get detailed content of a single item
+single_content = sdk.risalatAlHaramain.contents.singleContent(1, "en")
+
+# Quick search items by name
+name_search_result = sdk.risalatAlHaramain.contents.nameSearch("حصن", "ar")
+
+# Check available translation languages for an item
+risala_avail_langs = sdk.risalatAlHaramain.contents.availableLanguages(1, "ar")
+
+# Get translation of a content item into a target language
+content_translation = sdk.risalatAlHaramain.contents.contentTranslation(1, "en", "ar") # id, targetLanguage, language
+
+# ==========================================
+# 2. Islamic Content Modules (islamicContent)
+# ==========================================
+
+# Get Fatwas
+fatwas = sdk.risalatAlHaramain.islamicContent.fatwas({
+    "language": "en",    # Optional
+    "lang": "ar",        # Optional
+    "isFeatured": 1      # Optional: 0 or 1
+})
+
+# Get featured Hadiths
+hadeeths = sdk.risalatAlHaramain.islamicContent.hadeeths({
+    "language": "en",
+    "lang": "ar",
+    "isFeatured": 1
+})
+
+# Get featured Quran recitations
+quran_content = sdk.risalatAlHaramain.islamicContent.quran({
+    "language": "en",
+    "lang": "ar",
+    "isFeatured": 1
+})
+
+# ==========================================
+# 3. Platform Search (search)
+# ==========================================
+
+# Keyword text search across platform content
+search_result = sdk.risalatAlHaramain.search.contents("حصن", "en")
+
+# ==========================================
+# 4. Lookups & Meta (lookups)
+# ==========================================
+
+# Get available languages
+risala_langs = sdk.risalatAlHaramain.lookups.languages("en")
+
+# Get available content types
+content_types = sdk.risalatAlHaramain.lookups.contentTypes("en")
+```
+
+---
+
+### Bayan Al Islam Source (Bayan Al Islam API)
+
+**Postman Resources:** [Collection](https://byenah.com/download-request?name=Bayan%20Al%20Islam.postman_collection.json) | [Environment](https://byenah.com/download-request?name=Bayan%20al%20islam%20env.postman_environment.json)
+
+```python
+# 1. Get list of available languages
+bayan_langs = sdk.bayanAlIslam.languagesList("ar")
+
+# 2. Get content list tailored for Muslims
+muslim_list = sdk.bayanAlIslam.muslimList("en")
+
+# 3. Get content list tailored for Non-Muslims
+non_muslim_list = sdk.bayanAlIslam.nonMuslimList("en")
+
+# 4. Get details of a specific content item by ID
+content_details = sdk.bayanAlIslam.singleContent(22184, "en")
+
+# 5. Get languages list paginated and filtered by name
+paginated_langs = sdk.bayanAlIslam.paginatedLanguages({
+    "name": "English", # Optional
+    "page": 1,         # Optional
+    "language": "en"   # Optional
+})
+
+# 6. Get recent contents (Muslim/Non-Muslim updates)
+recent = sdk.bayanAlIslam.recentContents({
+    "lang": "ar",
+    "init": True,
+    "ids": [22184], # Optional: content IDs list
+    "language": "en" # Optional
+})
+
+# 7. Get website lookup variables
+lookups = sdk.bayanAlIslam.lookups("en")
+
+# 8. Search materials by title/name
+search_result = sdk.bayanAlIslam.nameSearch("حصن", "ar")
+
+# 9. Check available translation languages for a content ID
+avail_langs = sdk.bayanAlIslam.availableLanguages(22184, "ar")
+
+# 10. Get specific translation of a content item
+translation = sdk.bayanAlIslam.contentTranslation(22184, "en", "ar") # id, targetLanguage, language
+
+# 11. Get translations for media or PDF attachments of a content item
+attachments_trans = sdk.bayanAlIslam.attachmentsTranslation(22184, "en", "ar") # id, targetLanguage, language
+```
+
+---
+
+### Al Montaka Source (Al Montaka API)
+
+**API Documentation Link:** [Al Montaka API](https://documenter.getpostman.com/view/5211979/2s8YzMZ6Fu)
+
+```python
+# ==========================================
+# 1. Content and Comments (contents)
+# ==========================================
+
+# Get all comments for a specific content ID
+comments = sdk.alMontaka.contents.comments(1)
+
+# Add a new comment to a specific content item
+new_comment = sdk.alMontaka.contents.addComment(1, "Test comment")
+
+# Get filtered content by category IDs
+filtered_content = sdk.alMontaka.contents.content([1, 2])
+
+# ==========================================
+# 2. Site Lookups and Filters (lookups)
+# ==========================================
+
+# Get target age groups
+age_groups = sdk.alMontaka.lookups.ageGroups()
+
+# Get categories matching language and name filter
+categories = sdk.alMontaka.lookups.categories({
+    "languageId": 1,
+    "nameCont": "General"
+})
+
+# Get publishing entities matching language and name filter
+entities = sdk.alMontaka.lookups.entities({
+    "languageId": 1,
+    "nameCont": "Dar"
+})
+
+# Get expertise/scientific levels matching filter
+expert_levels = sdk.alMontaka.lookups.expertLevels({
+    "languageId": 1,
+    "nameCont": "Level"
+})
+
+# Get ideologies matching filter
+ideologies = sdk.alMontaka.lookups.ideologies({
+    "languageId": 1,
+    "nameCont": "Sunnah",
+    "parentId": 0
+})
+
+# Get available languages
+languages = sdk.alMontaka.lookups.languages()
+
+# Get/search scholars, narrators, or personalities
+persons = sdk.alMontaka.lookups.persons({
+    "nameCont": "Muhammad", # Optional
+    "page": 1              # Optional
+})
+
+# Get website sections matching filter
+sections = sdk.alMontaka.lookups.sections({
+    "languageId": 1,
+    "nameCont": "Section"
+})
+
+# Get tags matching filter
+tags = sdk.alMontaka.lookups.tags({
+    "languageId": 1,
+    "nameCont": "Tag"
+})
+
+# Get targeted groups of audience
+targeted_groups = sdk.alMontaka.lookups.targetedGroups()
+
+# Get integrated YouTube channels list
+youtube_channels = sdk.alMontaka.lookups.youtubeChannels()
+```
+
+---
+
+## Donation & Support
+
+You can support the projects and efforts of The Association for Multi-lingual Islamic Content through the following official channels:
+
+- [Support Projects (Wakfy)](https://islamiccontent.org/Wakfy)
+- [Bank Accounts](https://islamiccontent.org/Accounts)
+- [Association Store](https://store.islamiccontent.sa/)
+- [Annual Operational Support (الدعم التشغيلي السنوي للجمعية)](https://store.islamiccontent.sa/%D8%A7%D9%84%D9%85%D8%B5%D8%B1%D9%88%D9%81%D8%A7%D8%AA-%D8%A7%D9%84%D8%AA%D8%B4%D8%BA%D9%8A%D9%84%D9%8A%D8%A9-%D8%A7%D9%84%D8%B3%D9%86%D9%88%D9%8A%D8%A9-%D9%84%D9%84%D8%AC%D9%85%D8%B9%D9%8A-%D8%A9/p1950956689)

islamic_content_sdk-1.0.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+islamic_content_sdk/__init__.py,sha256=kIJsZXF4yM04AVzAQ7MNMz9WmK3tRENLO5L-IpvEs_0,71
+islamic_content_sdk/client.py,sha256=7SGjzRXCnnWRhC8h-tC3AS5hq7orutFZZ4R9kbjnK20,661
+islamic_content_sdk/services/__init__.py,sha256=RB5fNb6t1tSGDGDfPdNqCZ089_nckMi5p6sPzeoKaDg,24
+islamic_content_sdk/services/al_montaka.py,sha256=F6kR4fn-xoO9vPBmS-i5g5jD-eH8dtapvNkSRwYT0kM,4071
+islamic_content_sdk/services/base.py,sha256=y4Jgys9rKm4fmpVYbqIFXEVed8Mq9RG9hhh0TkJujp4,1510
+islamic_content_sdk/services/bayan_al_islam.py,sha256=9lfeOiRhmWy5uhKxlhm2OGgja4rCIyqkqThbuL182vI,2825
+islamic_content_sdk/services/hadeethenc.py,sha256=m-BL5zHZ0nLIlkVeiy75GnuBBJp1O8lyoGfr-yPaTJY,1521
+islamic_content_sdk/services/islamhouse.py,sha256=Kae0HBNSyOlKuxqge2-GNuccOzsEGGcR3YGntaSTO_8,8084
+islamic_content_sdk/services/quranenc.py,sha256=fiYwjiokBdcLlWKMUWE8LdzkQTupm5YDE6eihs9pKB0,1551
+islamic_content_sdk/services/risalat_al_haramain.py,sha256=p-xo94uF_ZpCQTsCYqKPAgJAzHt6BnMtEBv4CSQhQUc,4363
+islamic_content_sdk-1.0.0.dist-info/METADATA,sha256=UIEghnyo0D0gzKaQ50JG0oas2ZYHWX73MYbCkk7_VWg,16845
+islamic_content_sdk-1.0.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+islamic_content_sdk-1.0.0.dist-info/top_level.txt,sha256=YwyLzv-OrqzuVo3nCb7Hgnapar_zlJfH2DmJwCs2r5s,20
+islamic_content_sdk-1.0.0.dist-info/RECORD,,

islamic_content_sdk-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (70.2.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

islamic_content_sdk-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+islamic_content_sdk