diff --git a/README.md b/README.md index e64a61b..4af2a88 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Flask demo api -Demo api with Flask as backend and Redis as NoSql DB +Demo Flask app with sqlalchemy and PostgreSQL [![Static Badge](https://img.shields.io/badge/pi3c_nao-green?style=for-the-badge&logo=telegram&label=Telegram)](https://t.me/pi3c_nao) @@ -8,32 +8,16 @@ Demo api with Flask as backend and Redis as NoSql DB ## Задание -Создать docker-compose.yml разворачивающий приложение на python с простой реализацией REST API. Решение должно состоять из двух контейнеров: -а) Любая NoSQL DB. -б) Приложение на python, с использованием Flask, которое слушает на порту 8080 и принимает только методы GET, POST, PUT. +Необходимо написать программу, которая будет получать данные контакта (ID, Имя) из Битрикс24 по Webhook проверять имя контакта на наличие его в БД (PostgreSQL) +Женские имена таблица names_womanМужские имена таблица names_man +Далее, если нашел имя в БД мужчин ставить пол Мужчина, если нашел имя в БД женщин ставить Женщина +Далее передавать данные по гендеру обратно в контакт по ID -в) Создаем значение ключ=значение, изменяем ключ=новое_значение, читаем значение ключа. - -г) Вновь созданные объекты должны создаваться, изменяться и читаться из NoSQL DB. - - -## Описание API -- GET: - требует наличие аргумента key: http://localhost:8080/?key=blablabla - -- POST, PUT & DELETE: - принимают данные запроса в json формате - { - "key": "your_key", - "val": "your_val" - } - - -## Установка +## Установка и запуск - Клонируем репозиторий -`git clone https://git.pi3c.ru/pi3c/flask-demo-api.git` +`git clone https://git.pi3c.ru/pi3c/flask-webhook.git` - Запуск апи первый запуск после установки или обновления @@ -42,15 +26,7 @@ Demo api with Flask as backend and Redis as NoSql DB последующие запуски `docker-compose -f compose-app.yml up` -- Запуск тестов - первый запуск после установки или обновления - `docker-compose -f compose-tests.yml up --build` - - последующие запуски - `docker-compose -f compose-tests.yml up` - - Для остановки запущенных контейнеров `-c` `docker-compose -f compose-app.yml down` - or - `docker-compose -f compose-tests.yml down` +