Skip to content

a simple tool that allows users to download Surahs from the Quran conveniently.

Notifications You must be signed in to change notification settings

SkandarS0/quran_downloader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quran Downloader

Welcome to the Quran Downloader project, a simple tool that allows users to download Surahs from the Quran conveniently.

Description

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.

Installation

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.

With Docker

  1. Clone this repository:

    git clone https://github.com/SkandarS0/quran-downloader.git
    cd quran-downloader
  2. Build the Docker image:

    docker build -t quran-downloader .
  3. 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.

Without Docker

If you prefer to run the project without Docker, you can do so by following these steps:

  1. Clone this repository:

    git clone https://github.com/SkandarS0/quran-downloader.git
    cd quran-downloader
  2. Create a virtual environment:

    python3 -m venv venv
    source venv/bin/activate
  3. Install the project dependencies:

    pip install -r requirements.txt
  4. 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.

Features

  • 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.

About

a simple tool that allows users to download Surahs from the Quran conveniently.

Resources

Stars

Watchers

Forks