Skip to content

QuranHub/quran-images-utils

Repository files navigation

Quran Images Utils

License Badge PRs Welcome

QuranHub Banner Image

Utility scripts for Quran images.

How to use the scripts?

  1. Use image_downloader/download_pages.py to download Quran pages images from sources like KFGQPC website: Hafs or other recitations.
  2. Use image_prepare/prepare_imgs.py to process & prepare of the original Quran pages images for example crop, resize, optimize, etc.
  3. Use aya_locator/aya_locator.py to detect the ayas locations in the Quran pages images and generate a CSV file of those data.
  4. Finally, you can use csv_to_sqlite_db/csv_to_sqlite.py to convert the CSV data to a SQLite DB.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please read CONTRIBUTING.md for our code of conduct and details on contributing to the project.

Steps for contributing to this repository:

  1. Fork it.
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git add . git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Create new Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.