{"id":13408272,"url":"https://github.com/Alfanous-team/alfanous","last_synced_at":"2025-03-14T13:30:47.217Z","repository":{"id":3556195,"uuid":"4617289","full_name":"Alfanous-team/alfanous","owner":"Alfanous-team","description":"Alfanous is an Arabic search engine API provides the simple and advanced search in Quran , more features and many interfaces...","archived":false,"fork":false,"pushed_at":"2023-05-12T17:25:23.000Z","size":149399,"stargazers_count":264,"open_issues_count":111,"forks_count":90,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-03-14T02:00:43.398Z","etag":null,"topics":["api","arabic","django-application","indexing","python2","quran","search-engine"],"latest_commit_sha":null,"homepage":"http://www.alfanous.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Alfanous-team.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":"assem-ch"}},"created_at":"2012-06-10T18:31:51.000Z","updated_at":"2025-02-22T19:10:41.000Z","dependencies_parsed_at":"2023-01-13T13:00:15.342Z","dependency_job_id":null,"html_url":"https://github.com/Alfanous-team/alfanous","commit_stats":{"total_commits":24,"total_committers":2,"mean_commits":12.0,"dds":0.04166666666666663,"last_synced_commit":"594514729473c24efa3908e3107b45a38255de4b"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alfanous-team%2Falfanous","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alfanous-team%2Falfanous/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alfanous-team%2Falfanous/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alfanous-team%2Falfanous/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Alfanous-team","download_url":"https://codeload.github.com/Alfanous-team/alfanous/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243584092,"owners_count":20314698,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","arabic","django-application","indexing","python2","quran","search-engine"],"created_at":"2024-07-30T20:00:51.796Z","updated_at":"2025-03-14T13:30:47.195Z","avatar_url":"https://github.com/Alfanous-team.png","language":"Python","funding_links":["https://github.com/sponsors/assem-ch"],"categories":["Mobile Apps","Applications","Quranic Text and Reading (170 projects)"],"sub_categories":["Flutter","Python"],"readme":".. image:: https://github.com/Alfanous-team/alfanous/workflows/tests/badge.svg\n\n============\nAlfanous API\n============\n\n:Authors: `Authors.rst \u003chttps://github.com/Alfanous-team/alfanous/blob/master/AUTHORS.rst\u003e`_\n:Release: 0.7.30\n:License: `AGPL \u003chttps://github.com/Alfanous-team/alfanous/blob/master/LICENSE\u003e`_\n:Tracker: `Alfanous-team/alfanous/Issues \u003chttps://github.com/Alfanous-team/alfanous/issues\u003e`_\n:Mailinglist: `alfanous@googlegroups.com \u003chttp://groups.google.com/group/alfanous/\u003e`_\n\n=====\nUsage\n=====\nInstall it from Pypi:\n\n.. code-block:: sh\n\n $ sudo pip install alfanous\n\nYou can use it from console:\n\n.. code-block:: sh\n\n $ alfanous-console -a search -q الله\n $ alfanous-console -a search -q Allh\n\nor from Python:\n\n.. code-block:: python\n\n \u003e\u003e\u003e import alfanous\n \u003e\u003e\u003e alfanous.search(u\"الله\")\n \u003e\u003e\u003e alfanous.do({\"action\":\"search\",\"query\":u\"الله\"})\n \u003e\u003e\u003e alfanous.do({\"action\":\"search\",\"query\":u\"Allh\"}) # Buckwalter transliteration\n\nYou can use it also from the web service:\n\nhttp://alfanous.org/api/search?query=الله\n\nhttp://alfanous.org/api/search?query=Allh\n\n\n--------------\nFlags\n--------------\n\n======== ==================== ================= ================ ============================================ ================= ========================================================================================================================================================================\n number flag related action related unit description default value accepted values\n-------- -------------------- ----------------- ---------------- -------------------------------------------- ----------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------\n 1 **action** \u003cnone\u003e \u003cnone\u003e action to perform \"search\" search | suggest | show\n 2 unit search, suggest \u003cnone\u003e search unit \"aya\" aya | word | translation\n 2 ident \u003call\u003e \u003call\u003e identifier of requester [experimental] \"undefined\" undefined\n 3 platform \u003call\u003e \u003call\u003e platform used by requester \"undefined\" undefined | wp7 | s60 | android | ios | linux | window\n 4 domain \u003call\u003e \u003call\u003e web domain of requester if applicable \"undefined\" \\*\n 5a **query** search,suggest \u003call\u003e query attached to action \"\" \\*\n 5b **query** show \u003call\u003e query attached to action \"\" all | translations |recitations | information | hints | surates | chapters | defaults | flags | fields | fields_reverse | errors | domains | help_messages | roots\n 6 highlight search \u003call\u003e highlight method \"css\" css | html | genshi | bold | bbcode\n 7 script search aya, word script of aya text \"standard\" standard | uthmani\n 8 vocalized search aya, word enable vocalization of aya text \"True\" True | False\n 9 recitation search aya recitation id \"1\" 1 to 30\n 10 translation search aya, trans translation id \"None\" \\*\n 11 romanization search aya, word type of romanization \"none\" none | buckwalter | iso | arabtex\n 12a view search aya, word pre-defined configuration for view \"custom\" minimal | normal | full | statistic | linguistic | custom\n 12b view search translation pre-defined configuration for view \"custom\" minimal | normal | full | custom\n 13 prev_aya search aya enable previous aya retrieving \"False\" True | False\n 14 next_aya search aya enable next aya retrieving \"False\" True | False\n 15 sura_info search aya enable sura information retrieving \"True\" True | False\n 16 sura_stat_info search aya enable sura stats retrieving \"False\" True | False\n 17 word_info search aya, word enable word information retrieving \"True\" True | False\n 17a word_synonyms search aya enable retrieving of keyword synonyms \"False\" True | False\n 17b word_derivations search aya enable retrieving of keyword derivations \"True\" True | False\n 17c word_vocalizations search aya enable retrieving of keyword vocalizations \"True\" True | False\n 18 aya_position_info search aya enable aya position information retrieving \"True\" True | False\n 19 aya_theme_info search aya enable aya theme information retrieving \"True\" True | False\n 20 aya_stat_info search aya enable aya stat information retrieving \"True\" True | False\n 21 aya_sajda_info search aya enable aya sajda information retrieving \"True\" True | False\n 22 annotation_word search aya, word enable query terms annotations retrieving \"False\" True | False\n 23 annotation_aya search aya enable aya words annotations retrieving \"False\" True | False\n 24 sortedby search aya sorting order of results \"score\" total | score | mushaf | tanzil | subject\n 25 offset search \u003call\u003e starting offset of results \"1\" 1 to 6236\n 26 range search \u003call\u003e range of results \"10\" 1 to 25\n 27 page search \u003call\u003e page number [override offset] \"1\" 1 to 6236\n 28 perpage search \u003call\u003e results per page [override range] \"10\" 1 to 25\n 29 fuzzy search aya fuzzy search [exprimental] \"False\" True | False\n 30 aya search word,trans enable retrieving of aya text \"True\" True | False\n\n======== ==================== ================= ================ ============================================ ================= ========================================================================================================================================================================\n\n-----------------------\nAdvanced Query Examples\n-----------------------\n\nAya Search:\n\n* Simple search: الحمد\n* Phrases : \"الحمد لله\"\n* Logical relations - ANDNOT : (الصلاة - الزكاة)\n* Logical relations - AND : الصلاة + الزكاة\n* Logical relations - OR : الصلاة | الزكاة\n* Joker \\* : \\*نبي\\*\n* Joker \\? : نعم؟\n* Fielded search : سورة:يس ( look for other Fields_ )\n* Fielded search (2) : سجدة:نعم\n* Intervals : رقم_السورة:[1 الى 5] و الله\n* Partial vocalization : آية_:'مَن'\n* Tuples (root,type= أداة | اسم | فعل) as: {قول،اسم}\n* Derivations - lemma : \u003eمالك\n* Derivations - root : \u003e\u003eمالك\n\nTranslation Search:\n\n* Exact search: god\n* Phrase search: \"seven heavens\"\n* Logical relations - OR:\tprayer ANDNOT charity\n* Logical relations - AND: prayer AND charity\n* Logical relations - OR:\tprayer OR charity\n* Wildcards - Joker \\*: pray*\n* Wildcards - Joker \\?: produc?\n* Fielded search: \tlang:fr\n* Fielded search (2) : author:Shakir\n\n------\nFields\n------\n* Aya Search Fields:\n\n===== ==================== =================== =================== ============================================================\n n عربي English Values Description\n----- -------------------- ------------------- ------------------- ------------------------------------------------------------\n 1 رقم gid 1 to 6236 Global order of Aya in the whole Quran\n 2 رقم_الآية aya_id 1 to 300 order of Aya inside its Sura\n 3 آية aya Text Aya non-vocalized standard text ( used for search)\n 4 آية_ aya_ Text Aya vocalized standard text ( used for show/search)\n 5 عثماني uth Text Aya vocalized uthmani text ( used for show/search)\n 6 عثماني_ uth_ Text Aya vocalized uthmani text ( used for show)\n 7 موضوع subject Text Thematic Division: **Chapter** \u003e **Topic** \u003e **Subtopic**\n 8 فصل chapter Text Thematic Division: **Chapter** \u003e Topic \u003e Subtopic\n 9 فرع topic Text Thematic Division: Chapter \u003e **Topic** \u003e Subtopic\n 10 باب subtopic Text Thematic Division: Chapter \u003e Topic \u003e **Subtopic**\n 11 رقم_السورة sura_id 1 to 114 Order of Sura in Mus-haf\n 12 سورة sura_arabic Text Arabic Name of Sura\n 12+ سورة_إنجليزي sura_english Text English Name of Sura\n 12+ سورة_تهجئة sura Text Romanized Name of Sura\n 13 نوع_السورة sura_type_arabic مدنية|مكية Revelation place of Sura [Arabic]\n 13+ نوع_السورة_إنجليزي sura_type Meccan|Medinan Revelation place of Sura [English]\n 14 ترتيب_السورة sura_order 1 to 114 Revelation order of Sura\n 15 جزء juz 1 to 30 Structural Division : **Juz** \u003e Hizb \u003e Rub\n 16 حزب hizb 1 to 60 Structural Division : Juz \u003e **Hizb** \u003e Rub\n 17 نصف nisf 1 to 2 Deprecated\n 18 ربع rub 1 to 4 Structural Division : Juz \u003e Hizb \u003e **Rub**\n 19 صفحة page Number Structural Division : Page\n 19+ صفحة_هندي page_IN Number Structural Division : Page (INDIAN MUSHAF)\n 20 منزل manzil 1 to 7 Structural Division : **Manzil** \u003e Ruku\n 21 ركوع ruku Number Structural Division : Manzil \u003e **Ruku**\n 22 سجدة sajda نعم | لا Test existence of a Sajda\n 23 رقم_السجدة sajda_id 1 | 14 Order of the Sajda if exist\n 24 نوع_السجدة sajda_type واجبة|مستحبة Type of the Sajda if exist\n 25 ح_س s_l Number Number of **letters** in **Sura**\n 26 ك_س s_w Number Number of **words** in **Sura**\n 27 ج_س s_g Number Number of **God's names** in **Sura**\n 28 آ_س s_a Number Number of **Ayas** in **Sura**\n 29 ر_س s_r Number Number of **Ruku-s** in **Sura**\n 30 ح_آ a_l Number Number of **letters** in **Aya**\n 31 ك_آ a_w Number Number of **words** in **Aya**\n 32 ج_آ a_g Number Number of **God's names** in **Aya**\n===== ==================== =================== =================== ============================================================\n\n\n----------------\nSortedBy Options\n----------------\n* Aya Search:\n========== =================================================================================\n Option Description\n---------- ---------------------------------------------------------------------------------\n score The relevance of the results compared to the query keywords\n mushaf The default order of ayas in Mus-haf\n tanzil The revelation order\n subject The alphabetic order of the values for subjects fields\n ayalenght The length of ayah from the shortest to the longest\n FIELD The numerical order or alphabetic order of a costum field (see Fields_ )\n\n========== =================================================================================\n\n\n--------------\nSchema Samples\n--------------\n* Aya Search:\n\nSuggestions\n^^^^^^^^^^^\nflags:\n\n.. code-block:: python\n\n {\n \"action\"=\"suggest\",\n \"query\"=\"مءصدة\"\n }\n\nresponse:\n\n.. code-block:: python\n\n {\n \"suggest\": [\n [\"\\u0645\\u0621\\u0635\\u062f\\u0629\",\n [\"\\u0645\\u0642\\u062a\\u0635\\u062f\\u0629\", \"\\u0645\\u0624\\u0635\\u062f\\u0629\"]\n ]\n ],\n \"error\": {\n \"msg\": \"success ## action=suggest ; query=\\u0645\\u0621\\u0635\\u062f\\u0629\",\n \"code\": 0\n }\n }\n\nResults\n^^^^^^^\nflags:\n\n.. code-block:: python\n\n {\n \"action\":\"search\",\n \"query\": \"الكوثر\",\n \"sortedby\":\"score\",\n \"page\": 1,\n \"word_info\":True,\n \"highlight\":\"css\",\n \"script\": \"standard\",\n \"prev_aya\": True,\n \"next_aya\": True,\n \"sura_info\": True,\n \"aya_position_info\": True,\n \"aya_theme_info\": True,\n \"aya_stat_info\": True,\n \"aya_sajda_info\": True,\n \"annotation_word\": True,\n \"annotation_aya\": True,\n \"translation\":\"None\",\n \"recitation\": 1\n\n }\n\nresponse:\n\n.. code-block:: python\n\n {\n\n \"search\": {\n \"runtime\": 1.0951571464538574,\n \"interval\": {\n \"start\": 1,\n \"total\": 1,\n \"end\": 1\n }\n \"words\": {\n \"global\": {\n \"nb_words\": 1,\n \"nb_matches\": 1,\n \"nb_vocalizations\": 1,\n },\n \"individual\": {\n\n\t\t\t\t \"1\": {\n\t\t\t\t \"word\": \"\\u0627\\u0644\\u0643\\u0648\\u062b\\u0631\",\n\t\t\t\t \"nb_matches\": 1,\n\t\t\t\t \"nb_ayas\": 1,\n\t\t\t\t \"nb_vocalizations\": 1,\n\t\t\t\t \"vocalizations\": [\"\\u0627\\u0644\\u0652\\u0643\\u064e\\u0648\\u0652\\u062b\\u064e\\u0631\\u064e\"],\n\t\t\t\t },\n\t\t\t\t },\n\n },\n\n \"ayas\": {\n \"1\": {\n\n \"identifier\": {\n \"gid\": 6205,\n \"aya_id\": 1,\n \"sura_id\": 108,\n \"sura_name\": \"\\u0627\\u0644\\u0643\\u0648\\u062b\\u0631\",\n\n },\n \"aya\": {\n \"id\": 1,\n \"text\": \"\\u0625\\u0650\\u0646\\u0651\\u064e\\u0627 \\u0623\\u064e\\u0639\\u0652\\u0637\\u064e\\u064a\\u0652\\u0646\\u064e\\u0627\\u0643\\u064e \u003cspan class=\\\"match term0\\\"\u003e\\u0627\\u0644\\u0652\\u0643\\u064e\\u0648\\u0652\\u062b\\u064e\\u0631\\u064e\u003c/span\u003e\",\n \"recitation\": \"http://www.everyayah.com/data/Abdul_Basit_Murattal_64kbps/108001.mp3\",\n \"translation\": null,\n \"prev_aya\": {\n \"id\": 7,\n \"sura\": \"\\u0627\\u0644\\u0645\\u0627\\u0639\\u0648\\u0646\",\n \"text\": \"\\u0648\\u064e\\u064a\\u064e\\u0645\\u0652\\u0646\\u064e\\u0639\\u064f\\u0648\\u0646\\u064e \\u0627\\u0644\\u0652\\u0645\\u064e\\u0627\\u0639\\u064f\\u0648\\u0646\\u064e\",\n },\n \"next_aya\": {\n \"id\": 2,\n \"sura\": \"\\u0627\\u0644\\u0643\\u0648\\u062b\\u0631\",\n \"text\": \"\\u0641\\u064e\\u0635\\u064e\\u0644\\u0651\\u0650 \\u0644\\u0650\\u0631\\u064e\\u0628\\u0651\\u0650\\u0643\\u064e \\u0648\\u064e\\u0627\\u0646\\u0652\\u062d\\u064e\\u0631\\u0652\",\n },\n },\n\n\n \"sura\": {\n \"id\": 108,\n \"name\": \"\\u0627\\u0644\\u0643\\u0648\\u062b\\u0631\",\n \"type\": \"\\u0645\\u0643\\u064a\\u0629\",\n \"order\": 15,\n \"ayas\": 3,\n \"stat\": {\n \"words\": 10,\n \"letters\": 42,\n \"godnames\": 0,\n\n },\n },\n \"theme\": {\n \"chapter\": \"\\u0623\\u0631\\u0643\\u0627\\u0646 \\u0627\\u0644\\u0625\\u0633\\u0644\\u0627\\u0645 \",\n \"topic\": \"\\u0627\\u0644\\u062d\\u062c \\u0648\\u0627\\u0644\\u0639\\u0645\\u0631\\u0629 \",\n \"subtopic\": null\n },\n\n\n \"position\": {\n \"rub\": 0,\n \"manzil\": 7,\n \"ruku\": 550,\n \"hizb\": 60,\n \"page\": 602\n },\n \"sajda\": {\n \"exist\": false,\n \"id\": null,\n \"type\": null\n },\n\n \"stat\": {\n \"letters\": 16,\n \"godnames\": 0,\n \"words\": 3\n },\n \"annotations\": {\n \"1\": {\n \"arabicroot\": null,\n \"arabicmood\": null,\n \"number\": null,\n \"spelled\": \"\\u0627\\u0646\\u0627\\u0653\",\n \"aspect\": null,\n \"word_gid\": 75871,\n \"word_id\": 1,\n \"mood\": null,\n \"arabicspecial\": \"\\u0625\\u0650\\u0646\\u0651\",\n \"state\": null,\n \"arabiclemma\": \"\\u0625\\u0650\\u0646\\u0651\",\n \"gid\": 116333,\n \"type\": \"Particles\",\n \"aya_id\": 1,\n \"arabictoken\": null,\n \"form\": null,\n \"pos\": \"Accusative particle\",\n \"arabiccase\": \"\\u0645\\u0646\\u0635\\u0648\\u0628\",\n \"part\": \"\\u062c\\u0630\\u0639\",\n \"normalized\": \"\\u0625\\u0646\\u0627\\u0653\",\n \"case\": \"Accusative case\",\n \"sura_id\": 108,\n \"word\": \"\\u0625\\u0650\\u0646\\u0651\\u064e\\u0627\\u0653\",\n \"derivation\": null,\n \"arabicpos\": \"\\u062d\\u0631\\u0641 \\u0646\\u0635\\u0628\",\n \"person\": null,\n \"token\": null,\n \"gender\": null,\n \"voice\": null,\n \"order\": 1\n },\n \"2\": {\n \"arabicroot\": \"\\u0639\\u0637\\u0648\",\n \"arabicmood\": null,\n \"number\": \"\\u062c\\u0645\\u0639\",\n \"spelled\": \"\\u0627\\u0639\\u0637\\u064a\\u0646\\u0670\\u0643\",\n \"aspect\": \"Perfect verb\",\n \"word_gid\": 75872,\n \"word_id\": 2,\n \"mood\": null,\n \"arabicspecial\": null,\n \"state\": null,\n \"arabiclemma\": null,\n \"gid\": 116335,\n \"type\": \"Verbs\",\n \"aya_id\": 1,\n \"arabictoken\": null,\n \"form\": \"Fourth form\",\n \"pos\": \"Verb\",\n \"arabiccase\": null,\n \"part\": \"\\u062c\\u0630\\u0639\",\n \"normalized\": \"\\u0623\\u0639\\u0637\\u064a\\u0646\\u0670\\u0643\",\n \"case\": null,\n \"sura_id\": 108,\n \"word\": \"\\u0623\\u064e\\u0639\\u0652\\u0637\\u064e\\u064a\\u0652\\u0646\\u064e\\u0670\\u0643\\u064e\",\n \"derivation\": null,\n \"arabicpos\": \"\\u0641\\u0639\\u0644\",\n \"person\": \"\\u0645\\u062a\\u0643\\u0644\\u0645\",\n \"token\": null,\n \"gender\": \"\\u0645\\u0630\\u0651\\u0643\\u0631\",\n \"voice\": null,\n \"order\": 1\n },\n \"3\": {\n \"arabicroot\": null,\n \"arabicmood\": null,\n \"number\": null,\n \"spelled\": \"\\u0671\\u0644\\u0643\\u0648\\u062b\\u0631\",\n \"aspect\": null,\n \"word_gid\": 75873,\n \"word_id\": 3,\n \"mood\": null,\n \"arabicspecial\": null,\n \"state\": null,\n \"arabiclemma\": null,\n \"gid\": 116337,\n \"type\": \"determiner\",\n \"aya_id\": 1,\n \"arabictoken\": \"\\u0627\\u0644\",\n \"form\": null,\n \"pos\": null,\n \"arabiccase\": null,\n \"part\": \"\\u0633\\u0627\\u0628\\u0642\",\n \"normalized\": \"\\u0671\\u0644\\u0643\\u0648\\u062b\\u0631\",\n \"case\": null,\n \"sura_id\": 108,\n \"word\": \"\\u0671\\u0644\\u0652\\u0643\\u064e\\u0648\\u0652\\u062b\\u064e\\u0631\\u064e\",\n \"derivation\": null,\n \"arabicpos\": null,\n \"person\": null,\n \"token\": \"al\",\n \"gender\": null,\n \"voice\": null,\n \"order\": 1\n }\n },\n },\n },\n \"translation_info\": {},\n },\n\n \"error\": {\n \"code\": 0,\n \"msg\": \"success ## action=search ; query=\\u0627\\u0644\\u0643\\u0648\\u062b\\u0631\",\n }\n }\n\n\nTranslations\n^^^^^^^^^^^\nTODO\n\n\nInformation\n^^^^^^^^^^^\nflags:\n\n.. code-block:: python\n\n {\n \"action\"=\"show\",\n \"query\"=\"information\"\n }\n\nresponse:\n\n.. code-block:: python\n\n {\n \"show\": {\n \"information\": {\n \"engine\": \"Alfanous\",\n \"wiki\": \"http://wiki.alfanous.org/doku.php?id=json_web_service\",\n \"description\": \"Alfanous is a Quranic search engine provides simple and advanced search services in the diverse information of the Holy Quran .\",\n \"author\": \"Assem chelli\",\n \"version\": \"0.5\",\n \"contact\": \"assem.ch@gmail.com\",\n \"console_note\": \"this is console interface of Alfanous, try -h to get help \",\n \"json_output_system_note\": \"\\n This is the \u003ca href='http://json.org/'\u003eJSON\u003c/a\u003e output system of \u003ca href=\\\"http://wiki.alfanous.org\\\"\u003eAlfanous\u003c/a\u003e project .This feature is in Alpha test and the Json schema may be it's not stable . We are waiting for real feadbacks and suggestions to improve its efficacity,quality and stability. To contact the author ,please send a direct email to \u003cb\u003e assem.ch[at]gmail.com\u003c/b\u003e or to the mailing list \u003cb\u003ealfanous [at] googlegroups.com\u003c/b\u003e\\n \u003cbr/\u003e\u003cbr/\u003e For more details visit the page of this service \u003ca href=\\\"http://wiki.alfanous.org/doku.php?id=json_web_service\\\"\u003ehere\u003c/a\u003e\\n \"\n }\n },\n \"error\": {\n \"msg\": \"success ## action=show ; query=information\",\n \"code\": 0\n }\n }\n\n\nRecitations\n^^^^^^^^^^^\n\nflags:\n\n.. code-block:: python\n\n {\n \"action\"=\"show\",\n \"query\"=\"recitations\"\n }\n\nresponse (sample):\n\n.. code-block:: python\n\n {\n \"show\": {\n \"recitations\": {\n \"45\": {\n \"bitrate\": \"192kbps\",\n \"name\": \"English/Ibrahim Walk TEST\",\n \"subfolder\": \"English/Ibrahim_Walk_192kbps_TEST\"\n },\n \"54\": {\n \"bitrate\": \"128kbps\",\n \"name\": \"Salah Al Budair\",\n \"subfolder\": \"Salah_Al_Budair_128kbps\"\n }\n\n\n }\n },\n \"error\": {\n \"msg\": \"success ## action=show ; query=recitations\",\n \"code\": 0\n }\n }\n\n\nFields\n^^^^^^\n\nflags:\n\n.. code-block:: python\n\n {\n \"action\"=\"show\",\n \"query\"=\"fields\"\n }\n\nresponse:\n\n.. code-block:: python\n\n {\n \"show\": {\n \"fields\": {\n \"جزء\": \"juz\",\n \"عثماني \": \"uth\",\n \"نوع_السورة\": \"sura_type\",\n \"رقم_السجدة\": \"sajda_id\",\n \"صفحة\": \"page\",\n \"ربع\": \"rub\",\n \"ر_س\": \"s_r\",\n \"ركوع\": \"ruku\",\n \"رقم_السورة\": \"sura_id\",\n \"آ_س\": \"s_a\",\n \"آية_\": \"aya_\",\n \"موضوع\": \"subject\",\n \"ج_س\": \"s_g\",\n \"ك_آ\": \"a_w\",\n \"فصل\": \"chapter\",\n \"ح_آ\": \"a_l\",\n \"سورة\": \"sura\",\n \"فرع\": \"topic\",\n \"آية\": \"aya\",\n \"رقم_الآية\": \"aya_id\",\n \"عثماني_\": \"uth_\",\n \"ك_س\": \"s_w\",\n \"نوع_السجدة\": \"sajda_type\",\n \"رقم\": \"gid\",\n \"باب\": \"subtopic\",\n \"نصف\": \"nisf\",\n \"ح_س\": \"s_l\",\n \"حزب\": \"hizb\",\n \"منزل\": \"manzil\",\n \"ج_آ\": \"a_g\",\n \"سجدة\": \"sajda\",\n \"ترتيب_السورة\": \"sura_order\"\n }\n },\n \"error\": {\n \"msg\": \"success ## action=show ; query=fields\",\n \"code\": 0\n }\n }\n\n\n=======\nHacking\n=======\n-----\nBuild\n-----\n\nThe API uses many critical resources that must be downloaded and/or prepared to be used. To do that, just run this command in the root path of the project\n\n#. Install all building dependencies: `pyparsing \u003chttp://pyparsing.wikispaces.com/\u003e`_, `epydoc \u003chttp://epydoc.sourceforge.net/\u003e`_,\n `sphinx \u003chttp://sphinx.pocoo.org/\u003e`_.\n\n * (ubuntu 12.04): \n \n .. code-block:: sh\n \n $ sudo apt-get install python-qt4 qt4-dev-tools python-qt4-dev pyqt4-dev-tools\n $ sudo apt-get install python-distutils-extra\n $ sudo easy_install pyparsing epydoc sphinx\n\n\n\n\n#. Run the build command:\n\n .. code-block:: sh\n \n $ cd ../../\n $ make build\n\n\n\nFor more details check `Makefile \u003chttps://github.com/Alfanous-team/alfanous/blob/master/Makefile\u003e`_\n\n\n-------\nInstall\n-------\nTo install the API from the source (After Build_ ):\n\n.. code-block:: sh\n\n $ sudo python setup.py install\n\nA console interface will be installed automatically with the API:\n\n.. code-block:: sh\n\n $ alfanous-console -h\n usage: alfanous-console [flags]\n\n\n\n**note**: if you are looking for alfanous legacy code, you can find it under `legacy` branch\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlfanous-team%2Falfanous","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAlfanous-team%2Falfanous","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlfanous-team%2Falfanous/lists"}