Git Product home page Git Product logo

azanbot-twitter's Introduction

๐Ÿ•Œ AzanBot-Twitter

A Twitter bot notifier for azan in Malaysia, using data from Jabatan Kemajuan Agama Islam Malaysia (JAKIM).

Features

  • Displays prayer schedule for the day in Imsak notification.
  • Each azan notification message will include the next prayer time.
  • Can specify custom hashtags (inside main.py)
  • All logs will be stored inside a log file.
  • No need to set local timezone of the host.
  • See it in action @ https://twitter.com/dailyprayerKTN

Prerequisite

  • User need to specify their own Twitter API key inside config.py.
  • Users need to specify daerah or state zone inside config.py.

Usage

To use the AzanBot-Twitter, follow these steps:

  1. Clone this repository.
  2. Install the required packages using pip install -r requirements.txt.
  3. Set up your Twitter API key inside config.py.
  4. Specify the daerah or state zone inside config.py.
  5. Run python run.py to start the bot.

Future Plans

  • Add more error handling.
  • Add seasonal hashtags to be set.
  • Add random quote generation.

Contribution

Contributions to AzanBot-Twitter are always welcome! To contribute, follow these steps:

  1. Fork this repository.
  2. Create a new branch with a descriptive name.
  3. Make your changes and test them.
  4. Commit your changes and push them to your fork.
  5. Create a pull request to this repository.

FAQ

Q: Can I use this bot for other countries?

A: Currently, this bot only works for Malaysia. However, you can modify the code to work with other countries.

Q: How often does the bot check for azan times?

A: The bot refreshes for azan times every day at 12:05 AM

Q: How do I get Twitter API key?

A: To get Twitter API keys, you need to create a Twitter Developer Account and then create a Twitter App. From there you can grab the API key

Q: How do I know what code for specific timezone?

A: Can refer to https://www.e-solat.gov.my/. For example for KL, I will specify WLY01 under ZONE inside config.py

License

This project is licensed under the MIT License.

azanbot-twitter's People

Contributors

hachirosan avatar dependabot[bot] avatar

Stargazers

Alhassan Mousa avatar

Watchers

 avatar Kostas Georgiou 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.