https://github.com/mezgoodle/studyhelper
Bot in Telegram, which helps in study process
https://github.com/mezgoodle/studyhelper
aiogram aiogram3 python telegram-bot
Last synced: 6 months ago
JSON representation
Bot in Telegram, which helps in study process
- Host: GitHub
- URL: https://github.com/mezgoodle/studyhelper
- Owner: mezgoodle
- License: mit
- Created: 2023-02-03T16:58:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-01T17:51:49.000Z (about 1 year ago)
- Last Synced: 2025-06-12T12:13:43.931Z (7 months ago)
- Topics: aiogram, aiogram3, python, telegram-bot
- Language: Python
- Homepage:
- Size: 511 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
StudyHelper 
🌟Hello everyone! This is the pet-project as Telegram Bot for education.🌟
# StudyHelper
It is a Telegram bot that facilitates the learning process. You can read more about it [here](https://dev.to/mezgoodle/studyhelper-my-new-pet-projecttelegram-bot-3f41).
## Functionality
A list of key bot functions:
- Communication between teacher and student through a bot
- Get subject performance statistics
- Sending task solutions
And much more, which you can read about in the article.
## Installation and start
1. Since this is a regular GitHub project, you need to commit it first:
```bash
git clone https://github.com/mezgoodle/StudyHelper.git
```
2. Next, use the package manager **pip** to set dependencies:
```bash
pip install -r requirements.txt
```
3. After that, you need to set some environment variables. You can do this by writing their values to the `.env` file:
```bash
bot_token=""
access_id=""
access_key=""
```
Also, you have to set up other parameters in the [configuration file](https://github.com/mezgoodle/StudyHelper/blob/main/tgbot/config.py#L11_L13):
- bucket_name
- region_name
- admins
If you want, you can change the name of environment file.
## Example of usage
Here you can see the screenshot of the bot:
More examples can be found in the article on the blog.
## List of commands
A list of available commands, their description and role of the user.
| Command | Description | Role |
| ----------------- | ---------------------------------- | ------- |
| /start | Welcome message | Anybody |
| /help | Show the list of commands | Anybody |
| /cancel | Reset the state of the bot | Anybody |
| /register_student | Register as student | Anybody |
| /register_teacher | Register as teacher | Anybody |
| /is_teacher | Check if you are a teacher | Anybody |
| /is_student | Check if you are a student | Anybody |
| /my_subjects | Show your subjects(for both roles) | Anybody |
| /upcoming_tasks | Show upcoming tasks | Student |
| /create_subject | Create a new subject | Teacher |
## List of technologies
Here are the main technologies used in the project:
- Python - as a programming language
- aiogram - as a framework for Telegram bots
- boto3 - as a service layer for AWS
- pandas, seaborn - for data analysis and visualization
- tortoise ORM - as a database layer
## Contacts
If you have any questions or suggestions, you can contact me via [Telegram](https://t.me/sylvenis) or [Email](mailto:mezgoodle@gmail.com).