{"id":41328615,"url":"https://github.com/rahiel/BismillahBot","last_synced_at":"2026-03-10T05:01:37.063Z","repository":{"id":69156853,"uuid":"42925896","full_name":"rahiel/BismillahBot","owner":"rahiel","description":"A Telegram bot to explore the Holy Qur'an.","archived":false,"fork":false,"pushed_at":"2017-08-31T13:23:14.000Z","size":56,"stargazers_count":48,"open_issues_count":2,"forks_count":15,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-05T03:31:53.247Z","etag":null,"topics":["bot","quran","telegram"],"latest_commit_sha":null,"homepage":"https://telegram.me/BismillahBot","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/rahiel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-09-22T09:57:14.000Z","updated_at":"2025-02-16T01:28:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"3249c22f-d41d-4769-a874-531e4364309e","html_url":"https://github.com/rahiel/BismillahBot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rahiel/BismillahBot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rahiel%2FBismillahBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rahiel%2FBismillahBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rahiel%2FBismillahBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rahiel%2FBismillahBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rahiel","download_url":"https://codeload.github.com/rahiel/BismillahBot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rahiel%2FBismillahBot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30325598,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T01:36:58.598Z","status":"online","status_checked_at":"2026-03-10T02:00:06.579Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bot","quran","telegram"],"created_at":"2026-01-23T06:11:49.933Z","updated_at":"2026-03-10T05:01:36.989Z","avatar_url":"https://github.com/rahiel.png","language":"Python","funding_links":[],"categories":["Other (122 projects)"],"sub_categories":["Python"],"readme":"# BismillahBot\n\nبِسْمِ اللهِ الرَّحْمٰنِ الرَّحِيْمِ\n\nBismillahBot is a bot on Telegram to explore the Holy Qur'an.\n\n\u003c!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again --\u003e\n**Table of Contents**\n\n- [Usage](#usage)\n- [Installation](#installation)\n    - [Data files](#data-files)\n    - [Updating](#updating)\n- [License](#license)\n\n\u003c!-- markdown-toc end --\u003e\n\n# Usage\n\nUse the bot by messaging [Bismillahbot][] on [Telegram][]. For every verse the\nbot has an English translation from [Imam Ahmad Raza][], audio recitation\nby [Shaykh Mahmoud Khalil al-Husary][], and exegesis (tafsir)\nfrom [Tafsir al-Jalalayn][]. The translation and tafsir are available anywhere\non Telegram via [inline mode][], just start a text with `@BismillahBot` (for\nexample, type `@BismillahBot 1:1` in any chat). A conversation looks like:\n![example]\n\nAlso see [AudioQuranBot][], a bot that sends audio files of complete surahs.\n\n[BismillahBot]: https://telegram.me/BismillahBot\n[Telegram]: https://telegram.org/\n[Imam Ahmad Raza]: https://en.wikipedia.org/wiki/Ahmed_Raza_Khan_Barelvi\n[Shaykh Mahmoud Khalil al-Husary]: https://en.wikipedia.org/wiki/Mahmoud_Khalil_Al-Hussary\n[Tafsir al-Jalalayn]: http://www.altafsir.com/Al-Jalalayn.asp\n[inline mode]: https://telegram.org/blog/inline-bots\n[example]: https://i.imgur.com/kITXcHz.png \"Example conversation\"\n[AudioQuranBot]: https://github.com/rahiel/AudioQuranBot\n\n# Installation\n\nYou can run your own instance of BismillahBot. First you need to request a\n[bot username and token](https://core.telegram.org/bots#3-how-do-i-create-a-bot).\nYou also need a Unix-like system to run the bot on. BismillahBot is running on a\nDebian server. The following gets the code, and installs the dependencies on\nDebian/Ubuntu in a virtualenv:\n\n```bash\nsudo apt install redis-server git python3-pip python3-dev virtualenv\ngit clone https://github.com/rahiel/BismillahBot.git\ncd BismillahBot/\nvirtualenv -p python3 venv\n. venv/bin/activate\npip install -r requirements.txt --upgrade\n```\n\nIn the same directory you should define a `secret.py` with the token you got\nfrom the [BotFather](https://telegram.me/botfather):\n\n```python\nTOKEN = \"\u003cyour-token-here\u003e\"\n```\n\nDisable group chats for the bot by sending the BotFather the `/setjoingroups`\ncommand and customize the bot further.\n\n## Data files\n\nThe bot serves Quranic data collected from several projects. These are necessary\nfor the bot to function. Run the following in the bot's directory to get the\ndata:\n\n```bash\nwget \"http://tanzil.net/trans/en.ahmedraza\"\nwget \"http://tanzil.net/res/text/metadata/quran-data.xml\"\nwget \"http://www.altafsir.com/Books/Al_Jalalain_Eng.pdf\"\npdftotext -nopgbrk Al_Jalalain_Eng.pdf\nwget \"http://www.everyayah.com/data/Husary_128kbps/000_versebyverse.zip\"\nunzip -d Husary 000_versebyverse.zip\nwget \"http://www.everyayah.com/data/quranpngs/000_images.zip\"\nunzip -d quran_images 000_images.zip\n```\n\nWe do some post-processing on the images. First we remove the empty area's from\nthe edges with [ImageMagick](https://www.imagemagick.org/script/index.php) and\n[GNU parallel](https://www.gnu.org/software/parallel/):\n``` shell\ncd quran_images/\nparallel \"echo {}; convert {} -trim {}\" ::: *.png\n```\nThen we optimize the images with [pngout](http://www.jonof.id.au/kenutils):\n``` shell\nparallel \"pngout {}\" ::: *.png\n```\n\nYou could use other data files, like\n[other translations](http://tanzil.net/trans/) or\n[audio recitations](http://www.everyayah.com/data/status.php). These choices are\ncurrently hardcoded in the bot, so\n[file an issue](https://github.com/rahiel/BismillahBot/issues/new) if you'd like\nto use different data.\n\nIf all went fine you can now run the bot with `python bismillah.py`.\n\n## Updating\n\nThe bot (and dependencies) can be updated by running the following in its\ndirectory:\n\n```bash\ngit pull\n. venv/bin/activate\npip install -r requirements.txt -U\n```\n\n# License\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU Affero General Public License as published by the Free\nSoftware Foundation, either version 3 of the License, or (at your option) any\nlater version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License along\nwith this program. If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frahiel%2FBismillahBot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frahiel%2FBismillahBot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frahiel%2FBismillahBot/lists"}