{"id":28629830,"url":"https://github.com/mezgoodle/studyhelper","last_synced_at":"2025-07-23T18:06:29.502Z","repository":{"id":115219054,"uuid":"597114682","full_name":"mezgoodle/StudyHelper","owner":"mezgoodle","description":"Bot in Telegram, which helps in study process","archived":false,"fork":false,"pushed_at":"2025-01-01T17:51:49.000Z","size":523,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-12T12:13:43.931Z","etag":null,"topics":["aiogram","aiogram3","python","telegram-bot"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mezgoodle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-03T16:58:39.000Z","updated_at":"2025-01-01T17:51:53.000Z","dependencies_parsed_at":"2024-02-22T10:28:22.745Z","dependency_job_id":"dead57ba-3b60-49a7-aee0-045bea3cf145","html_url":"https://github.com/mezgoodle/StudyHelper","commit_stats":null,"previous_names":["mezgoodle/studyhelper"],"tags_count":0,"template":false,"template_full_name":"mezgoodle/bot_template","purl":"pkg:github/mezgoodle/StudyHelper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezgoodle%2FStudyHelper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezgoodle%2FStudyHelper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezgoodle%2FStudyHelper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezgoodle%2FStudyHelper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mezgoodle","download_url":"https://codeload.github.com/mezgoodle/StudyHelper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezgoodle%2FStudyHelper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266726675,"owners_count":23974928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aiogram","aiogram3","python","telegram-bot"],"created_at":"2025-06-12T12:13:40.757Z","updated_at":"2025-07-23T18:06:29.470Z","avatar_url":"https://github.com/mezgoodle.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 id=\"project-title\" align=\"center\"\u003e\n  StudyHelper \u003cimg alt=\"logo\" width=\"40\" height=\"40\" src=\"https://raw.githubusercontent.com/mezgoodle/images/master/MezidiaLogoTransparent.png\" /\u003e\u003cbr\u003e\n  \u003cimg alt=\"language\" src=\"https://img.shields.io/badge/language-python-brightgreen?style=flat-square\" /\u003e\n  \u003cimg alt=\"issues\" src=\"https://img.shields.io/github/issues/mezgoodle/StudyHelper\n  \" /\u003e\n  \u003cimg alt=\"GitHub closed issues\" src=\"https://img.shields.io/github/issues-closed/mezgoodle/StudyHelper?style=flat-square\" /\u003e\n  \u003cimg alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/mezgoodle/StudyHelper?style=flat-square\" /\u003e\n  \u003cimg alt=\"GitHub closed pull requests\" src=\"https://img.shields.io/github/issues-pr-closed/mezgoodle/StudyHelper?style=flat-square\" /\u003e\n  \u003cimg alt=\"GitHub Repo stars\" src=\"https://img.shields.io/github/stars/mezgoodle/StudyHelper?style=flat-square\"\u003e\n  \u003ca href=\"https://codeium.com\"\u003e\n  \u003cimg alt=\"Built with the Codeium\" src=\"https://codeium.com/badges/main\"\u003e\n  \u003c/a\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n 🌟Hello everyone! This is the pet-project as Telegram Bot for education.🌟\n\u003c/p\u003e\n\n# StudyHelper\n\nIt 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).\n\n## Functionality\n\nA list of key bot functions:\n\n- Communication between teacher and student through a bot\n- Get subject performance statistics\n- Sending task solutions\n\nAnd much more, which you can read about in the article.\n\n## Installation and start\n\n1. Since this is a regular GitHub project, you need to commit it first:\n\n```bash\ngit clone https://github.com/mezgoodle/StudyHelper.git\n```\n\n2. Next, use the package manager **pip** to set dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\n3. After that, you need to set some environment variables. You can do this by writing their values to the `.env` file:\n\n```bash\nbot_token=\"\u003cyour_bot_token\u003e\"\naccess_id=\"\u003cyour_access_id\u003e\"\naccess_key=\"\u003cyour_access_key\u003e\"\n```\n\nAlso, you have to set up other parameters in the [configuration file](https://github.com/mezgoodle/StudyHelper/blob/main/tgbot/config.py#L11_L13):\n\n- bucket_name\n- region_name\n- admins\n\nIf you want, you can change the name of environment file.\n\n## Example of usage\n\nHere you can see the screenshot of the bot:\n\n![Screenshot](./docs/images/screenshot.png)\n\nMore examples can be found in the article on the blog.\n\n## List of commands\n\nA list of available commands, their description and role of the user.\n\n| Command           | Description                        | Role    |\n| ----------------- | ---------------------------------- | ------- |\n| /start            | Welcome message                    | Anybody |\n| /help             | Show the list of commands          | Anybody |\n| /cancel           | Reset the state of the bot         | Anybody |\n| /register_student | Register as student                | Anybody |\n| /register_teacher | Register as teacher                | Anybody |\n| /is_teacher       | Check if you are a teacher         | Anybody |\n| /is_student       | Check if you are a student         | Anybody |\n| /my_subjects      | Show your subjects(for both roles) | Anybody |\n| /upcoming_tasks   | Show upcoming tasks                | Student |\n| /create_subject   | Create a new subject               | Teacher |\n\n## List of technologies\n\nHere are the main technologies used in the project:\n\n- Python - as a programming language\n- aiogram - as a framework for Telegram bots\n- boto3 - as a service layer for AWS\n- pandas, seaborn - for data analysis and visualization\n- tortoise ORM - as a database layer\n\n## Contacts\n\nIf you have any questions or suggestions, you can contact me via [Telegram](https://t.me/sylvenis) or [Email](mailto:mezgoodle@gmail.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmezgoodle%2Fstudyhelper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmezgoodle%2Fstudyhelper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmezgoodle%2Fstudyhelper/lists"}