.. role:: shell(code) :language: shell

Приложение для практического руководства_ по разработке бэкенд-сервисов на Python (на основе вступительного испытания_ в Школу бэкенд-разработки Яндекса_ в 2019 году).

.. _практического руководства: https://habr.com/ru/company/yandex/blog/499534/ .. _вступительного испытания: https://disk.yandex.ru/i/dA9umaGbQdMNLw .. _Школу бэкенд-разработки Яндекса: https://yandex.ru/promo/academy/backend-school/

.. image:: https://github.com/alvassin/backendschool2019/workflows/CI/badge.svg?branch=master&event=push :target: https://github.com/alvassin/backendschool2019/actions?query=workflow%3ACI

Что внутри?

Приложение упаковано в Docker-контейнер и разворачивается с помощью Ansible.

Внутри Docker-контейнера доступны две команды: 🐚analyzer-db — утилита для управления состоянием базы данных и 🐚analyzer-api — утилита для запуска REST API сервиса.

Как использовать?

Как применить миграции:

.. code-block:: shell

docker run -it \
    -e ANALYZER_PG_URL=postgresql://user:[email protected]/analyzer \
    alvassin/backendschool2019 analyzer-db upgrade head

Как запустить REST API сервис локально на порту 8081:

.. code-block:: shell

docker run -it -p 8081:8081 \
    -e ANALYZER_PG_URL=postgresql://user:[email protected]/analyzer \
    alvassin/backendschool2019

Все доступные опции запуска любой команды можно получить с помощью аргумента 🐚--help:

.. code-block:: shell

docker run alvassin/backendschool2019 analyzer-db --help
docker run alvassin/backendschool2019 analyzer-api --help

Опции для запуска можно указывать как аргументами командной строки, так и переменными окружения с префиксом 🐚ANALYZER (например: вместо аргумента 🐚--pg-url можно воспользоваться 🐚ANALYZER_PG_URL).

Как развернуть?

Чтобы развернуть и запустить сервис на серверах, добавьте список серверов в файл deploy/hosts.ini (с установленной Ubuntu) и выполните команды:

.. code-block:: shell

cd deploy
ansible-playbook -i hosts.ini --user=root deploy.yml

Разработка

Быстрые команды

• 🐚make Отобразить список доступных команд
• 🐚make devenv Создать и настроить виртуальное окружение для разработки
• 🐚make postgres Поднять Docker-контейнер с PostgreSQL
• 🐚make lint Проверить синтаксис и стиль кода с помощью pylama_
• 🐚make clean Удалить файлы, созданные модулем distutils_
• 🐚make test Запустить тесты
• 🐚make sdist Создать source distribution_
• 🐚make docker Собрать Docker-образ
• 🐚make upload Загрузить Docker-образ на hub.docker.com

.. _pylama: https://github.com/klen/pylama .. _distutils: https://docs.python.org/3/library/distutils.html .. _source distribution: https://packaging.python.org/glossary/

Как подготовить окружение для разработки?

.. code-block:: shell

make devenv
make postgres
source env/bin/activate
analyzer-db upgrade head
analyzer-api

После запуска команд приложение начнет слушать запросы на 0.0.0.0:8081. Для отладки в PyCharm необходимо запустить 🐚env/bin/analyzer-api.

Как запустить тесты локально?

.. code-block:: shell

make devenv
make postgres
source env/bin/activate
pytest

Для отладки в PyCharm необходимо запустить 🐚env/bin/pytest.

Как запустить нагрузочное тестирование?

Для запуска locust_ необходимо выполнить следующие команды:

.. code-block:: shell

make devenv
source env/bin/activate
locust

После этого станет доступен веб-интерфейс по адресу http://localhost:8089

.. _locust: https://locust.io

Ссылки

• Трансляция с ответами_ на наиболее частые вопросы по тестовым заданиям и Школе.

.. _Трансляция с ответами: https://www.youtube.com/watch?v=Bf0liGAahao