Random Coffee bot for the Mattermost

Официальная документация

1. Склонируйте репозиторий на локальную машину:

  git clone [email protected]:Studio-Yandex-Practicum/RandomCoffeeBot.git

2. Установите poetry

  curl -sSL https://install.python-poetry.org | python3 -

Warning Не используйте pip install poetry

3. Первичная установка зависимостей

  poetry install

Если нет poetry, следуйте инструкции по установке

4. Активируйте venv

  poetry shell

Warning Если вы работаете в pycharm, то: Пройдите в add interpreter и установите Poetry Environment

5. Настроить pre-commit

  pre-commit install

Примечание: Перед каждым коммитом будет запущен линтер и форматтер, который автоматически отформатирует код согласно принятому в команде codestyle.

1. Запустите open-source платформу Mattermost и БД командой:

  docker-compose -f infra/docker-compose.tests.yml up -d

Warning Не выключайте контейнер с платформой

2. После запуска контейнера, перейдите по этой ссылке:

  http://localhost:8065

3. Пройдите регистрацию

Note Документация Mattermost

4. Создайте бота. Add Bot Account

Note Достаточно задать: Username Role (System Admin)

5. Скопируйте Token

Warning После нажатия Done, вы больше не сможете посмотреть Access Token

6. Создайте в корневой папке .env файл

  touch .env

7. Заполните по примеру со своими значениями Скопируйте этот файл

1. Примените миграции базы данных

  alembic upgrade head

2. Запустите бота командой На mac/linux/windows

  python3 src/run.py

3. При необходимости добавьте в БД тестовых пользователей и пары На mac/linux/windows

  python3 fill_db.py

Дополнительно вы можете использовать следующие аргументы командной строки:

  -u, --num_users     Количество пользователей для добавления в БД (по умолчанию: 10)
  -p, --num_pairs     Количество пар для каждого пользователя (по умолчанию: 3)

Например:

  python fill_db.py -u 20 -p 4

Это добавит 20 пользователей и создаст для каждого из них 4 пары совпадений в базе данных

Note Если количество пользователей недостаточно для создания заданного количества уникальных пар, то скрипт задаст максимально возможное количество пар для каждого пользователя