GithubHelp home page GithubHelp logo

grqa's Introduction

grqa

Narrated Ibn `Abbas:

The Prophet (ﷺ) embraced me and said, “O Allah! Teach him (the knowledge of) the Book (Qur’an).”

Sahih al-Bukhari 7270

grqa (short for "Get Random Qur'an Ayat) is a small program that allows you to fetch random verses from the Qur'an in your terminal. There are two instances, one written in bash (compatible with v. 3.2 and up) and one Python2/3 compatible instance.

Installation

Dependencies: wget, bash, su, chmod, python (if using gqra-py)

su
cd /usr/bin
wget https://raw.githubusercontent.com/zamiur/grqa/master/gqra (or gqra-py)
chmod +x grqa (or gqra-py)

Optional step (If you don't want this just continue as usual with the wget command)

vi gqra (or gqra-py) # Edit the "cd /usr/bin" line to the directory of moshaf
wget https://raw.githubusercontent.com/zamiur/grqa/master/quran.txt
exit

Usage

You can run it by typing grqa orgrqa-py anywhere

Example output:

zamiur@ayylmao:/usr/bin$ grqa
44|32|وَلَقَدِ اخْتَرْنَاهُمْ عَلَى عِلْمٍ عَلَى الْعَالَمِينَ
zamiur@ayylmao:/usr/bin$

License

This program is freeware and should be treated as public domain.

Future Plans (possibly)

Ideas considered "feature-creep-esque" (I might make a whole new program for these)

  • Implement recitation
  • Fetch information and show meanings/definition*

Ideas that could be implemented

  • Get specific Qur'an ayat (for example grqa 1 5 will print out ayat 5 of Surah Fatiha)
  • Fetch information and show meanings/definition*
  • Check if moshaf (quran.txt) exists, if not download again.

*As to how much information should be necessary before it can be considered more of a feature creep

Changelog

1.0.0 - Initial build (Both bash and python)

1.0.1 - Patch to fix shuf: ./quran.txt: No such file or directory. By default, the Qur'an moshaf is stored in /usr/bin. Optionally the user can edit the directory line and set a custom directory where the moshaf is located.


External Resources

The Quranic Arabic Corpus

Tanzil (source for quran moshaf in txt form)

Al Quran KSU Electronic Moshaf

grqa's People

Contributors

zamiur avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.