{"id":15794594,"url":"https://github.com/a-menshikov/ylab_email_reader_bot","last_synced_at":"2026-04-11T01:46:23.811Z","repository":{"id":204438177,"uuid":"707215711","full_name":"a-menshikov/Ylab_Email_reader_bot","owner":"a-menshikov","description":"Бот для чтения электронной почты. Выполнен в рамках стажировки в компании Y_lab.","archived":false,"fork":false,"pushed_at":"2023-10-19T13:06:09.000Z","size":353,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-12T00:14:59.605Z","etag":null,"topics":["aiogram","celery","celerybeat","django","django-ninja","docker","docker-compose","flower","postgresql","python","redis"],"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/a-menshikov.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}},"created_at":"2023-10-19T12:59:20.000Z","updated_at":"2023-10-30T09:08:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"1a95e68c-2976-4585-906d-9dc8a35239d4","html_url":"https://github.com/a-menshikov/Ylab_Email_reader_bot","commit_stats":null,"previous_names":["a-menshikov/ylab_email_reader_bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-menshikov%2FYlab_Email_reader_bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-menshikov%2FYlab_Email_reader_bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-menshikov%2FYlab_Email_reader_bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-menshikov%2FYlab_Email_reader_bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/a-menshikov","download_url":"https://codeload.github.com/a-menshikov/Ylab_Email_reader_bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246525879,"owners_count":20791803,"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","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","celery","celerybeat","django","django-ninja","docker","docker-compose","flower","postgresql","python","redis"],"created_at":"2024-10-05T00:00:21.308Z","updated_at":"2026-04-11T01:46:18.781Z","avatar_url":"https://github.com/a-menshikov.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Чат-бот для чтения электронной почты\n\nВыполнен в рамках стажировки в компании Y_lab, которая проходила с августа по октябрь 2023 года.\n\nПозволяет получать новые письма электронной почты в чат-боте для Telegram. Поддерживает возможность отслеживания нескольких ящиков и фильтрации писем по их отправителям.\n\n## Основные технологии разработки продукта\n\n- Python 3.10\n- Django 4.1 (async)\n- Aiogram\n- Celery\n- Flower\n- PostgreSQL 15\n- Redis\n- Docker\n\n## Развертывание проекта\n\n### Требования\n\n- Установленный Docker и Docker Compose\n- GNU Make\n\n### Инструкция\n\n1. Склонируйте репозиторий\n\n   ```bash\n   git clone \u003cссылка на репозиторий\u003e\n   ```\n\n2. Создайте файл .env и заполните его по примеру .env_example своими данными\n3. Поднимите контейнеры\n\n   ```bash\n   make up-d\n   ```\n\n4. Примените миграции\n\n   ```bash\n   make migrate\n   ```\n\n5. Соберите статику\n\n   ```bash\n   make collectstatic\n   ```\n\n6. Чтобы остановить контейнеры, выполните команду\n\n   ```bash\n   make down\n   ```\n\n## High-level design\n\n![HLD](./readme_images/HLD.png)\n\n## Схема БД проекта\n\n![DB](./readme_images/database.png)\n\n## Use cases\n\n1. Регистрация пользователя в боте\n\n    ![UC_registration](./readme_images/uc_registration.png)\n\n2. Добавление пользователем нового почтового ящика для отслеживания\n\n    ![UC_add_email_box](./readme_images/uc_add_email_box.png)\n\n3. Получение пользователем нового email-сообщения от бота\n\n    ![UC_new_email_message](./readme_images/uc_new_email_message.png)\n\n## Примеры использования специфических методов\n\n- После успешного запуска проекта, откройте \u003chttp://localhost:8000/api/v1/docs\u003e для доступа к документации по api проекта\n\n## Контакты\n\n**telegram** [@Menshikov_AS](https://t.me/Menshikov_AS)  \n**e-mail** \u003ca.menshikov1989@gmail.com\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-menshikov%2Fylab_email_reader_bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa-menshikov%2Fylab_email_reader_bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-menshikov%2Fylab_email_reader_bot/lists"}