IITM-BS Bots for staying up to date with all the events and deadlines

Welcome to the IIT Madras-BS Uodates Bot repository ! This repository contains two folders: one for a WhatsApp bot and another for a Telegram bot. These bots are designed to provide details about today's live sessions and schedules specifically tailored for BS students

Features

• Telegram Bot(v1)(Under Development):

  • Fetches information on live sessions happening today.
  • Displays the daily schedule.
  • Seamless interaction within the Telegram platform.

• WhatsApp Bot:(under Development)

  • Under development

• Checkout Good Docs for getting information about All features and Under Development versions Google Docs

v1 (Telegram Bot )

• Progress Tracker

  • Create Basic framework
  • Create Class for handling various commands
  • Create Frontend of bot using commands

• Workflow Sheet Link:

  • For getting all information about v1 Telegram Bot kindly go through this Google Docs

• WorkFlow Chart

  

Documentation reference

• Python Telegram Bot : https://core.telegram.org/bots/api

Guide to contributing

To make the contributions to the repo, follow these steps to set up project locally:

1. Fork this Repository on your account

2. Clone the Repository:

   git clone https://github.com/your-username/IITM-BS-bots.git
   cd IITM-BS-bots

3. Install Dependencies:

   pip install -r requirements.txt

4. Run and test the Bots:

   • Telegram Bot:
     • Note: For running the Telegram bot , you need to get your bot token for testing purpose and save that bot token in your PC local variables under the names as given in the code , for that you need to create bot token for main bot given in the code,however, i have also provided bot tokens , test bot tokens

• Webhook link :

  • For hosting bot during local development we need tunnel For that you can you vscode inbuilt tunnel and get the link from there , and paste it in the code

• Start the Telegram bot:

  cd Telegram\ bot
  python main_bot.py

Community and Discussions

Have questions, ideas, or need help? Check out our Discussions) to engage with the community.

Community Resources

• Discord: Engage with the community.
• workflow

Test bot tokens and Links to test bot (telegram)

• test bot tokens:
  • MAIN = 6677627030:AAElX2DcR0vWqDGHdgbTio9og1DLJiMK5Mw
• test bot links:
  • Main Bot Link (for testing)

Contributing

We welcome contributions! If you have any suggestions, improvements, or bug fixes, feel free to open an issue or submit a pull request.

Live Bots Links

• Production Bot

License

This project is licensed under the MIT License - see the LICENSE file for details.

Help and contact:

• reach out