Git Product home page Git Product logo

time-to-pray's Introduction

Time to Pray Time to Pray Icon

Time to Pray is a desktop utility designed to keep you informed about Islamic prayer times. Directly from your system tray, view a real-time countdown to the next prayer. The application proactively retrieves the monthly prayer schedule for your chosen location and caches the data for instantaneous reference. Stay on track with your prayer commitments, knowing the exact time remaining until the next call.

Features

  • Real-time countdown to the next prayer, accessible from the system tray.
  • Proactively fetches the monthly prayer schedule based on your configured location.
  • Easy-to-access "Settings" dialog for configuring your preferred city and selecting your desired prayer times calculation method.
  • Utilizes PyQt6 for a seamless user interface experience.

Setup & Installation

Using pip (Recommended)

pip install time-to-pray

After installation, you can run the application with:

time-to-pray

Manual Installation

1. Clone the Repository

git clone https://github.com/omerbustun/time-to-pray.git
cd time-to-pray

2. Install Dependencies

Make sure you have Python installed. Then, install the required packages:

pip install -r requirements.txt

3. Run

To run the application:

python src/main.py

Usage

Once launched, an icon will appear in your system tray. Right-click the icon to access the settings or hover to view the detailed countdown.

Configuration

The application uses the settings.json file for configuration. You can use the "Settings" dialog in the application or manually edit this file (not recommended). The configuration parameters are:

  • city: The city you are located in.
  • country: The country name or code (e.g., "tr" for Turkey).
  • latitude & longitude: The geographical coordinates of your location. The application automatically fetches these from the API based on the specified city and country.
  • method: The method used to calculate prayer times.

Acknowledgements

This project utilizes the Aladhan API to fetch prayer times. We are grateful to Aladhan.com for providing this valuable service to the community.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the GNU General Public License, version 3 (GPLv3). See the LICENSE file for the full license text.

time-to-pray's People

Contributors

omerbustun avatar

Stargazers

 avatar Javier Rodrigo López avatar Ömer Furkan Demircioğlu avatar

Watchers

 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.