/paraicehockey

Командный дипломный проект: Телеграм бот для НКО “Федерация адаптивного хоккея”.

Primary LanguagePython

Python badge badge badge

Project Paraicehockey

Содержание

  1. О чём проект?

  2. Структура проекта

  3. Подготовка к запуску

    3.1. Клонирование проекта из репозитория

    3.2. Настройка poetry

    3.3. Настройка переменных окружения

  4. Запуск бота

  5. FAQ Мониторинг

1. О чём проект?

Телеграм-бот для НКО “Федерация адаптивного хоккея”, который поможет пользователям познакомиться с ее деятельностью, получить информацию о мероприятиях и проектах, которые она организует, задать вопрос сотрудникам.

“Федерация адаптивного хоккея” - некоммерческая организация, которая создает условия для развития адаптивных видов хоккея в России, повышает их роль в социальной реабилитации детей с инвалидностью. Например, обучает тренеров, судей, волонтеров-пушеров (помощников на коньках), поддерживает новые и действующие команды, содействует разработке специального спортивного инвентаря, организует мероприятия – турниры, летний инклюзивный лагерь, интенсивы.

Федерация — единственная в России организация, которая занимается развитием адаптивного хоккея для детей на системном уровне и объединяет детские команды со всех уголков страны.

Сайт Федерации - https://paraicehockey.ru/federatsiya-adaptivnogo-hokkeya/

Телеграм - канал - https://t.me/paraicehockey

2. Структура проекта

Нужно дописать

3. Подготовка к запуску

3.1. Клонирование проекта из репозитория

Clone the repository to your computer:

git@github.com:Studio-Yandex-Practicum/paraicehockey.git

3.2. Poetry (инструмент для работы с виртуальным окружением и сборки пакетов):

Poetry - это инструмент для управления зависимостями и виртуальными окружениями, также может использоваться для сборки пакетов.

Как скачать и установить?

Установка:

Установите poetry следуя инструкции с официального сайта.

Команды для установки: Для UNIX-систем и Bash on Windows вводим в консоль следующую команду:

curl -sSL https://install.python-poetry.org | python - Для WINDOWS PowerShell:

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -


После установки перезапустите оболочку и введите команду > poetry --version Если установка прошла успешно, вы получите ответ в формате

Poetry (version 1.2.0) Для дальнейшей работы введите команду:

poetry config virtualenvs.in-project true Выполнение данной команды необходимо для создания виртуального окружения в папке проекта.

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

poetry install Результатом выполнения команды станет создание в корне проекта папки .venv. Зависимости для создания окружения берутся из файлов poetry.lock (приоритетнее) и pyproject.toml

Для добавления новой зависимости в окружение необходимо выполнить команду

poetry add <package_name> Пример использования:

poetry add requests Также poetry позволяет разделять зависимости необходимые для разработки, от основных. Для добавления зависимости необходимой для разработки и тестирования необходимо добавить флаг --dev

poetry add <package_name> --dev Пример использования:

poetry add flake8 --dev

Порядок работы после настройки

Чтобы активировать виртуальное окружение, введите команду:

poetry shell Существует возможность запуска скриптов и команд с помощью команды без активации окружения:

poetry run <script_name>.py Примеры:

poetry run python <script_name>.py

poetry run pytest

poetry run black Порядок работы в оболочке не меняется. Пример команды для Win:

python bin\main.py Доступен стандартный метод работы с активацией окружения в терминале с помощью команд:

Для WINDOWS:

source .venv/Scripts/activate Для UNIX:

source .venv/bin/activate

3.3. Настройка переменных окружения

Перед запуском проекта необходимо создать копию файла .env_example, назвав его .env и установить значение токена бота и придумать секретный ключ

4. Запуск бота

В процессе разработки отладка производится на личном боте, для этого нужно в файле .env в переменной BOT_TOKEN указать токен вашего бота.

Запуск бота командой из директории paraicehockey: python -m bin.run_bot

В проект добавлен pre-commit для предварительной проверки flake8 и isort перед commit:

Он должен быть установлен глобально, а не в виртуальном окружении проекта, где вы собираетесь его использовать. pip install --user pre-commit

Теперь включим pre-commit в текущем репозитории.

pre-commit install

Проверим, что конфигурационный файл валиден, а заодно и что всё нынешнее содержимое репозитория удовлетворяет описанными правилам:

pre-commit run --all-files

Team