https://github.com/a-menshikov/ylab_email_reader_bot

Бот для чтения электронной почты. Выполнен в рамках стажировки в компании Y_lab.
https://github.com/a-menshikov/ylab_email_reader_bot

aiogram celery celerybeat django django-ninja docker docker-compose flower postgresql python redis

Last synced: 7 months ago
JSON representation

Бот для чтения электронной почты. Выполнен в рамках стажировки в компании Y_lab.

• Host: GitHub
• URL: https://github.com/a-menshikov/ylab_email_reader_bot
• Owner: a-menshikov
• License: mit
• Created: 2023-10-19T12:59:20.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-19T13:06:09.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T00:14:59.605Z (about 1 year ago)
• Topics: aiogram, celery, celerybeat, django, django-ninja, docker, docker-compose, flower, postgresql, python, redis
• Language: Python
• Homepage:
• Size: 345 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Чат-бот для чтения электронной почты

Выполнен в рамках стажировки в компании Y_lab, которая проходила с августа по октябрь 2023 года.

Позволяет получать новые письма электронной почты в чат-боте для Telegram. Поддерживает возможность отслеживания нескольких ящиков и фильтрации писем по их отправителям.

## Основные технологии разработки продукта

- Python 3.10

- Django 4.1 (async)

- Aiogram

- Celery

- Flower

- PostgreSQL 15

- Redis

- Docker

## Развертывание проекта

### Требования

- Установленный Docker и Docker Compose

- GNU Make

### Инструкция

1. Склонируйте репозиторий

   ```bash

   git clone <ссылка на репозиторий>

   ```

2. Создайте файл .env и заполните его по примеру .env_example своими данными

3. Поднимите контейнеры

   ```bash

   make up-d

   ```

4. Примените миграции

   ```bash

   make migrate

   ```

5. Соберите статику

   ```bash

   make collectstatic

   ```

6. Чтобы остановить контейнеры, выполните команду

   ```bash

   make down

   ```

## High-level design

![HLD](./readme_images/HLD.png)

## Схема БД проекта

![DB](./readme_images/database.png)

## Use cases

1. Регистрация пользователя в боте

    ![UC_registration](./readme_images/uc_registration.png)

2. Добавление пользователем нового почтового ящика для отслеживания

    ![UC_add_email_box](./readme_images/uc_add_email_box.png)

3. Получение пользователем нового email-сообщения от бота

    ![UC_new_email_message](./readme_images/uc_new_email_message.png)

## Примеры использования специфических методов

- После успешного запуска проекта, откройте  для доступа к документации по api проекта

## Контакты

**telegram** [@Menshikov_AS](https://t.me/Menshikov_AS)  

**e-mail**