π MechIfy - Your Ultimate Mechanical Engineering Study Bot π€
Welcome to MechIfy! This bot is designed to assist Mechanical Engineering students by providing resources, study assistance, and interactive learning support. Whether you need help with a specific topic or access to resources, MechIfy is here to guide you through your academic journey.
β¨ Features
- Resources π: Get quick access to curated study materials based on your year of study or exam category.
- AI Instructor π€: Ask the bot any question related to Mechanical Engineering, and it will provide an informative and engaging response.
- About βΉοΈ: Learn more about the purpose and development of MechIfy.
- Developers π¨βπ»: Get to know the team behind MechIfy.
π Getting Started
- Python 3.7+
- Telegram Bot API token
-
Clone the repository:
git clone https://github.com/gashu-101/Mechify.git cd Mechify
-
Install dependencies:
pip install -r requirements.txt
-
Set up your environment variables:
- Replace the placeholders in the bot script with your API keys and credentials:
BOT_TOKEN
YOUTUBE_API_KEY
COHERE_API_KEY
- You can store these in a
.env
file for easier management.
- Replace the placeholders in the bot script with your API keys and credentials:
-
Start the bot:
python bot.py
-
Interact with the bot on Telegram:
- Search for your bot by name on Telegram and start a conversation.
- /start: Start the bot and view the main menu.
- Handle Messages: Send a message to the bot to ask a question or request resources.
When users start the bot, they receive a welcome message along with a menu offering different options:
πWelcome to AAIT Mechanical Engineering Study Bot (Mechify)!π
Choose an option below to get started:
Users can select their year or exam category to access relevant study materials:
π Click below to access your study resources and level up your learning! ππ
Users can ask the bot about any topic, and the bot will generate a detailed response using Cohere's AI:
Please mention the topic you want to learn about π, I'm here to help as your Ai Instructor! π€
Information about the developers behind the bot:
π¨βπ» Developed with Passion by the AAIT Mechanical Engineering Team! π©βπ»
- The bot gracefully handles API errors and informs the user if it is unable to generate a response or fetch a YouTube video.
- Cohere API for natural language processing.
- YouTube Data API for fetching relevant video content.
Happy Studying! π