Skip to content

An NLP based Telegram Bot that pushes KTU Announcements Notifications

License

Notifications You must be signed in to change notification settings

AJAYK-01/KTU-Notifier

Repository files navigation

Note

KTU has updated their website to use an API and React, and hence the web scraper in this project no longer works.
An update to use the api (api.ktu.edu.in) is required for this project to run, and any PRs for the same are welcome!


Check Related Issue #22

KTU Notifier

Gives Notifications of KTU announcements from their site using a Telegram Bot ( http://t.me/ktunotifbot )

Workflow

Instructions to create your own version of this bot

  • Clone the Repo.
  • Install the requirements.txt using pip.
  • Create a new Telegram Bot using BotFather in telegram.
  • Create a Firebase Realtime Database for handling subscribers and storing notifications cache.
  • Make a file named .env in the root folder and add the line TOKEN=XXXXXX (Your telegram bot token).
  • Also add the firebase credentials to the .env file.
  • Run bot.py in your system and you'll see that the bot starts responding to commands on Telegram.
  • Your bot should work as long as you have bot.py running.
  • You can host it to Heroku to run forever using instructions at https://github.com/michaelkrukov/heroku-python-script.

Big thanks to @nandakishormpai2001 for adding an NLP based filterer that checks for relevancy of each KTU Notification

Screenshot of .env file

Contributions will be Appreciated 😊