Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

A lightweight python prayer times/athan application for windows and linux that operates offline
https://github.com/0xzer0x/athany

adhan aladhan athan azan islam muslim muslim-prayer-times prayer prayer-times prayertimes pysimplegui python python-ui

Last synced: 4 months ago
JSON representation

A lightweight python prayer times/athan application for windows and linux that operates offline

Host: GitHub
URL: https://github.com/0xzer0x/athany
Owner: 0xzer0x
License: mit
Created: 2022-11-18T07:39:34.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2023-06-04T20:17:22.000Z (over 1 year ago)
Last Synced: 2024-08-05T04:03:44.303Z (6 months ago)
Topics: adhan, aladhan, athan, azan, islam, muslim, muslim-prayer-times, prayer, prayer-times, prayertimes, pysimplegui, python, python-ui
Language: Python
Homepage:
Size: 52.8 MB
Stars: 18
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

Awesome-Muslims - Athany

README

        






  

    

  

Athany


  


    a python application to remind you of your purpose

    


    


    

    

    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

        Building from source

      

    

    Usage

    Roadmap

    Contributing

    License

    Contact

    Acknowledgments

  


## About The Project

[![Athany Screen Shot][banner]][latest-release]

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

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

- [![python][python]][python-url]

- [![pysimplegui][psg]][psg-url]

(back to top)


## Getting Started

Install the [latest stable version][latest-release] 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][fonts-download-url] used in application.

- `python-tk` Tkinter package (Linux users only)

- `libappindicator-gtk3` & [appindicator shell extension][gnome-appindicator-ext] if you're using Gnome (Linux users only)

### Installation

1. Install dependencies (Linux users only)

   ```sh

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

   ```

2. Clone the repo

   ```sh

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

   ```

3. Install python packages

   ```sh

   cd athany

   pip install -r requirements.txt

   ```

4. Run the application

   ```sh

   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

```sh

    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

![choose-location][choose-location]

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)

![main-window][main-window]

the settings window can be accessed through the bottom left button

![settings-window-general-tab][settings-window-general-tab]

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

![settings-window-custom-athan-tab][settings-window-custom-athan-tab]

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

![settings-window-offset-tab][settings-window-offset-tab]

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

![advanced-settings-tab][advanced-settings-tab]

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](https://github.com/0xzer0x/athany/tree/master/images)

(back to top)


## Roadmap

- [x] Add advanced settings tab

  - [x] change calculation method

  - [x] use custom fajr & isha angles

- [ ] Add translations

- [ ] make an Android version using `kivy` library

See the [open issues](https://github.com/0xzer0x/athany/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 - [email protected]

Project Link: [https://github.com/0xzer0x/athany](https://github.com/0xzer0x/athany)

(back to top)


## Acknowledgments

- [AlAdhan API](https://aladhan.com/prayer-times-api)

- [adhanpy library](https://github.com/alphahm/adhanpy)

- [hijri-converter library](https://hijri-converter.readthedocs.io/en/stable/index.html)

- [Muezzin](https://github.com/DBChoco/Muezzin)

- [Athan audios source](https://www.assabile.com/adhan-call-prayer)

- [This README template](https://github.com/othneildrew/Best-README-Template)

(back to top)


[latest-release]: https://github.com/0xzer0x/athany/releases/latest

[python]: https://img.shields.io/badge/Python-yellowgreen?style=for-the-badge&logo=Python&logoColor=white

[psg]: https://img.shields.io/badge/PySimpleGUI-blue?style=for-the-badge&logo=Python&logoColor=white

[python-url]: https://python.org

[psg-url]: https://pysimplegui.org

[banner]: images/banner.jpg

[choose-location]: images/choose-location-121-en.png

[main-window]: images/main-window-121-en.png

[settings-window-general-tab]: images/general-settings-121-en.png

[settings-window-custom-athan-tab]: images/custom-athan-121-en.png

[settings-window-offset-tab]: images/offset-tab-121-en.png

[advanced-settings-tab]: images/advanced-settings-121-en.png

[gnome-appindicator-ext]: https://extensions.gnome.org/extension/615/appindicator-support/

[fonts-download-url]: https://github.com/0xzer0x/athany/releases/download/1.0.0-stable/fonts.zip