Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/shubhamatkal/student-telegram-bot

chatbot mongodb python selenium telegram

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/shubhamatkal/student-telegram-bot
Owner: shubhamatkal
License: gpl-3.0
Created: 2023-11-10T15:55:09.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-04-10T05:49:55.000Z (9 months ago)
Last Synced: 2024-04-10T06:39:25.423Z (9 months ago)
Topics: chatbot, mongodb, python, selenium, telegram
Language: Python
Homepage:
Size: 85.9 KB
Stars: 12
Watchers: 1
Forks: 9
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 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  

[![Discord](https://img.shields.io/discord/1173095754961801286)](https://discord.gg/hux9vWjVhR)

[![GitHub issues](https://img.shields.io/github/issues/shubhamatkal/IITM-BS-bots)](https://github.com/shubhamatkal/IITM-BS-bots/issues)

[![GitHub forks](https://img.shields.io/github/forks/shubhamatkal/IITM-BS-bots)](https://github.com/shubhamatkal/IITM-BS-bots/network/members)

[![GitHub Repo stars](https://img.shields.io/github/stars/shubhamatkal/IITM-BS-bots)](https://github.com/shubhamatkal/IITM-BS-bots/stargazers)

[![GitHub contributors](https://img.shields.io/github/contributors/shubhamatkal/IITM-BS-bots)](https://github.com/shubhamatkal/IITM-BS-bots/graphs/contributors)

## 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](https://docs.google.com/document/d/1yjr_NXChKjF3HIbJfOVPO2BQ8AqG9RMoNGmtE4Ih1C0/edit?usp=sharing)

## v1 (Telegram Bot ) 

  - ## Progress Tracker

    - [X] 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](https://docs.google.com/document/d/1yjr_NXChKjF3HIbJfOVPO2BQ8AqG9RMoNGmtE4Ih1C0/edit?usp=sharing)

- ## WorkFlow Chart

    [![cmd-flowchart.png](https://i.postimg.cc/1XSX0Lhv/cmd-flowchart.png)](https://postimg.cc/xJs9npdm)

 ## 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:**

   ```bash

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

   cd IITM-BS-bots

   ```

3. **Install Dependencies:**

   ```bash

   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](https://github.com/shubhamatkal/IITM-BS-bots/edit/main/README.md#test-bot-tokens-and-links-to-test-bot-telegram)

  - 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:

     ```bash

     cd Telegram\ bot

     python main_bot.py

     ```

## Community and Discussions

Have questions, ideas, or need help? Check out our [Discussions](https://discord.gg/hux9vWjVhR)) to engage with the community.

## Community Resources

- [Discord](https://discord.gg/hux9vWjVhR): Engage with the community.

- [workflow](https://docs.google.com/document/d/1yjr_NXChKjF3HIbJfOVPO2BQ8AqG9RMoNGmtE4Ih1C0/edit?usp=sharing)

## Test bot tokens and Links to test bot (telegram)

  - test bot tokens:

    - MAIN = 6677627030:AAElX2DcR0vWqDGHdgbTio9og1DLJiMK5Mw

  - test bot links:

    - [Main Bot Link (for testing)](t.me/test_foundation_iitmbs_bot)

      

## 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](https://t.me/iitm_bs_updatesbot)

  

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/shubhamatkal/IITM-BS-bots/blob/main/LICENSE) file for details.

## Help and contact:

- [reach out](https://github.com/shubhamatkal)