CR SOAPBOX

---

CR SOAPBOX is a personalized TIME TABLE Manager for IIITT Students and Teachers. By registering with your IIITT ROLL No or Email ID , you can get the Personalized Daily time table, Bunk manager(for Students ) , Can Make Changes in Timetable (for Teachers) and many more. It's totally an alternative for Class representative 😉.

📝 Table of Contents

• About
• How it works
• Usage
• Getting Started
• Built Using
• Authors
• Acknowledgments

🧐 About

CR SOAPBOX is an alternative for Class Representative.

Students:

• Can get timetable (Up-to-date).
• Can set & get attendance (Bunk manager).
• Can receive announcements (Creation and Deletion of classes, Messages, Files, Polls, etc.).

Teachers:

• Can get personal and grade timetables (Up-to-date).
• Can modify timetable (Create and Cancel classes).
• Can make announcements (messages,polls,files, etc.)

💭 How it works

• By starting the server the bot will fetch the timetable and other details from the json files in the project.

• The bot uses the Telegram API to fetch messages, Python Telegram Bot module to reply to messages.

• The entire bot was written in Python 3.8 (.py) and initializing script was written in bash shell script (.sh).

🎈 Usage

Start the bot by sending :

  $ /start

• The bot will ask the user whether he is a student or teacher.

Student:

• Bot will ask the user to send IIITT Roll no to log in.

• The bot first extracts the grade from the user's roll no, process it and store it in database.

• if the roll no does not exists then it will send an error message.

• Then the bot will responds according to the student's requests.

• Here is the demo of Students:
  
  

Teachers:

• Bot will ask the user to send IIITT Mail address to log in.

• The bot will check if the user entered email id is of teachers from IIITT.

• if it not belongs to a teacher from IIITT it will through an error.

• Then the bot will responds according to the teacher's requests.

• Hear is the demo of Teachers
  
  

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You can find the required python modules in requirments.txt file:

  $ python-telegram-bot
  $ pytz

You can install these modules by running this command in terminal:

  $ pip3 install -r requirements.txt

Installing

1. Clone the repository:

  $ git clone https://github.com/DattatreyaReddy/CR-Soapbox.git
  $ cd CR-Soapbox/

2. Head to data/bottkn.txt and replace the text with the bot token from @botfather in telegram.

3. Polling/Web-hooking

• To Deploy the bot with polling ignore this step (good for initial development).
• To Deploy the bot with web-hook refer Python-telegram-bot (Good for server deployment).

4. Add executable permissions to start.sh file and run it:

  $ chmod +x start.sh
  $ ./start.sh

• Screen shot :
  
  

⛏️ Built Using

• Telegram API
• python-telegram-bot - Python Telegram API Wrapper

✍️ Authors

• @dattatreyareddy - Idea & Initial work

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• code - python-telegram-bot_Code_Snippets , pythontelegrambotgroup
• people - @anoopjt, @fahad