README.md

Athany

a python application to remind you of your purpose


View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Building from source
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

قال تعالى: {وَمَا خَلَقْتُ ٱلْجِنَّ وَٱلْإِنسَ إِلَّا لِيَعْبُدُونِ (٥٦) مَآ أُرِيدُ مِنْهُم مِّن رِّزْقٍۢ وَمَآ أُرِيدُ أَن يُطْعِمُونِ (٥٧) إِنَّ ٱللَّهَ هُوَ ٱلرَّزَّاقُ ذُو ٱلْقُوَّةِ ٱلْمَتِينُ (٥٨)} [الذاريات]

Athany is a lightweight python program for windows and linux that calculates the times for the five mandatory muslim prayers, tells you the time remaining until the next prayer, and plays the athan sound when the prayer time comes.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Install the latest stable version using the windows setup provided in the release, If you want the latest code version up and running follow these simple steps.

Prerequisites

• Python >= 3.9

• Fonts used in application.

• python-tk Tkinter package (Linux users only)

• libappindicator-gtk3 & appindicator shell extension if you're using Gnome (Linux users only)

Installation

1. Install dependencies (Linux users only)

   sudo apt-get install -y python3-tk python3-dev libappindicator3-1 libappindicator3-dev

2. Clone the repo

   git clone https://github.com/0xzer0x/athany.git

3. Install python packages

   cd athany
   pip install -r requirements.txt

4. Run the application

   python main.py

(back to top)

Building from source

Replace the single-quotes with double-quotes if you're using windows and : with ;

• After the installation steps, execute the following commands. You will find the built application folder in the dist directory

    pip install pyinstaller
    pyinstaller --noconfirm --onedir --windowed --icon 'images/athany_icon.ico' --add-data 'src/Data:src/Data' --name 'athany' main.py

(back to top)

Usage

On first launch, the choose-location window will prompt you for a valid location. you can either type your location manually or use the automatically fetched location (note: your location is fetched using your public IP, so it may not be totally accurate)

the settings window can be accessed through the bottom left button

the general settings tab has the main app settings (mute athan, saving location, theme, change language, change/download athan sound)

the custom athan tab allows you to choose a local audio file (.wav, .mp3) to play instead of the offered athans

the offset tab allows you to adjust prayer times by adding/subtracting minutes from the default calculated time

the advanced settings tab allows you to use a different calculation method or set the calculation parameters manually. It also shows you the default method used in your country

check out other screenshots

(back to top)

Roadmap

• Add advanced settings tab
  • change calculation method
  • use custom fajr & isha angles
• Add translations
• make an Android version using kivy library

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Fursan team - y.essam2256@nu.edu.eg

Project Link: https://github.com/0xzer0x/athany

(back to top)

Acknowledgments

• AlAdhan API
• adhanpy library
• hijri-converter library
• Muezzin
• Athan audios source
• This README template

(back to top)