Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ibnaleem/quran.py
A Python package that simplifies access to the content of QurAn.com's API, providing user-friendly classes and methods for effortless retrieval of Quranic data.
https://github.com/ibnaleem/quran.py
islam islamic python quran quran-api quran-audio quran-info quran-json quran-search quran-translation
Last synced: 7 days ago
JSON representation
A Python package that simplifies access to the content of QurAn.com's API, providing user-friendly classes and methods for effortless retrieval of Quranic data.
- Host: GitHub
- URL: https://github.com/ibnaleem/quran.py
- Owner: ibnaleem
- License: mit
- Created: 2023-05-31T20:06:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-15T20:42:59.000Z (3 months ago)
- Last Synced: 2024-09-15T21:40:01.601Z (3 months ago)
- Topics: islam, islamic, python, quran, quran-api, quran-audio, quran-info, quran-json, quran-search, quran-translation
- Language: Python
- Homepage:
- Size: 51.8 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
quran.py
A Python package that simplifies access to the content of QurAn.com's API, providing user-friendly classes and methods for effortless retrieval of Quranic data.
## Disclaimer
#### This repository has no affiliation with, authorisation from, maintenance by, sponsorship from, or endorsement by Qur'An.com (https://quran.com) or any of its affiliates or subsidiaries.
## Purpose
In the name of Allah, the Most Merciful, the Most Compassionate, the King of all creation. All praise is due to Allah; we praise Him; seek His help and forgiveness; we seek refuge in Allah from the evils of ourselves and the evils of our actions. For whoever Allah guides none can misguide and whoever He misguides none can guide; I bear witness that there is no true God but Allah alone with no partners and I bear witness that Muhammad ﷺ is His slave and Messenger. May Allah's peace and blessings be upon Muhammad ﷺ, his family, his companions and those who follow them until the Day of Judgement.
It is no surpise that [Qur'An.com](https://quran.com/) is (one of) the most famous online Qur'An/Islamic resources available for the Ummah, including verse and word specific translations, Tafsirs, audios, juz numbers, and places of revelation for each Surah. After noticing [Qur'An.com's tedious (and well constructed) API](https://quran.api-docs.io/v4/getting-started/introduction), I decided to create a Python package specifically designed to assist developers in creating Islamic apps. This package will provide a comprehensive set of classes and methods, aiming to optimize their coding process and save valuable time. Quran.py offers the following:
- Translations
- Tafsirs & Tafsir Info
- Audios of Qur'An recitations
- Recitation Styles
- Languages
- Chapter Info
- Juz numbers
- The verses only revealed in Madīnah
- The verses only revealed in Mecca
- Indopak, Uthmani, and Imlaei Quranic Script
- *more*
## Contributions
I welcome contributions from the community and appreciate the time and effort put into making this project better. To contribute, please follow the guidelines and steps outlined below:
### Fork the Repository
Start by [forking this repository](https://github.com/ibnaleem/quran.py/fork). You can do this by clicking on the ["Fork"](https://github.com/ibnaleem/quran.py/fork) button located at the top right corner of the GitHub page. This will create a personal copy of the repository under your own GitHub account.
### Clone the Repository
Next, clone the forked repository to your local machine using the following command:
```bash
$ git clone https://github.com/yourusername/quran.py.git
```
Navigate to the cloned directory:
```bash
$ cd quran.py
```
### Create a New Branch
Before making any changes, it's recommended to create a new branch. This ensures that your changes won't interfere with other contributions and keeps the main branch clean. Use the following command to create and switch to a new branch:
```bash
$ git checkout -b branch-name
```
### Make the Desired Changes
Now, you can proceed to make your desired changes to the project. Whether it's fixing bugs, adding new features, improving documentation, or optimizing code, your efforts will be instrumental in enhancing the project.
### Commit and Push Changes
Once you have made the necessary changes, commit your work using the following commands:
```bash
$ git add .
$ git commit -m "Your commit message"
```
Push the changes to your forked repository:
```bash
$ git push origin branch-name
```
### Submit a Pull Request
Head over to the [original repository](https://github.com/ibnaleem/quran.py) on GitHub and go to the ["Pull requests"](https://github.com/ibnaleem/quran.py/pulls) tab.
1. Click on the "New pull request" button.
2. Select your forked repository and the branch containing your changes.
3. Provide a clear and informative title for your pull request, and use the description box to explain the modifications you have made.
4. Finally, click on the "Create pull request" button to submit your changes.
### [Join the Discord](https://discord.gg/WzAmb6zKvP)
Once you have submitted a pull request, I will review your changes and may provide feedback or request further adjustments. [Join the Discord and create a ticket](https://discord.gg/WzAmb6zKvP) specifying your pull request title and GitHub username. Promptly address any concerns, and collaborate with me (and others) to ensure the smooth progress of your contributions.
Your dedication and contributions are deeply appreciated, and I make Du'aa that your efforts bring great blessings to you. Together, let's make this project a remarkable success, Ameen.