Welcome to the Quran Downloader project, a simple tool that allows users to download Surahs from the Quran conveniently.
Quran Downloader is a Python-based application that helps users select and download specific Surahs from the Quran via a menu-driven interface. It retrieves metadata about the Quran from an online source and uses that information to allow you to choose the Surahs you need.
To set up and run this project, you need Docker. The presence of a Dockerfile
in the project allows for easy setup and
execution within a Docker environment.
-
Clone this repository:
git clone https://github.com/SkandarS0/quran-downloader.git cd quran-downloader
-
Build the Docker image:
docker build -t quran-downloader .
-
Run the Docker container:
docker run -it quran-downloader
Once the Docker container is running, the
main.py
script will execute, launching an interactive menu for selecting and downloading Surahs.
If you prefer to run the project without Docker, you can do so by following these steps:
-
Clone this repository:
git clone https://github.com/SkandarS0/quran-downloader.git cd quran-downloader
-
Create a virtual environment:
python3 -m venv venv source venv/bin/activate
-
Install the project dependencies:
pip install -r requirements.txt
-
Run the project:
python main.py
Main Features:
- Choose Surahs: Select one or more Surahs by their numbers using the menu.
- Download Surahs: Start downloading the selected Surahs.
- Interactive menu for selecting Surahs to download.
- Downloads can be tailored by selecting individual Surahs or ranges.
- Asynchronous operations for efficient metadata loading and downloading.