diff --git a/readme.md b/readme.md new file mode 100644 index 0000000000000000000000000000000000000000..2bb5b8433cc9ba71b23b9368b8f1a7ea349c9538 --- /dev/null +++ b/readme.md @@ -0,0 +1,29 @@ +## Рнформация Рѕ приложении + +Приложение используется для СЃР±РѕСЂР° статистики ping РґРѕ задананных источников. +Рсточники РјРѕРіСѓС‚ быть заданы РІ РІРёРґРµ ip или имени хоста. +Так Р¶Рµ РјРѕР¶РЅРѕ задать интервал времени, СЃ которым Р±СѓРґСѓС‚ посылаться проверочные сигналы. +Есть возможность приостановить Рё возобновить отправку сигналов. + +## Запуск + +1. Для успешного старта приложения надо иметь запущенный постгрес СЃ созданной РІ нем базой данных РїРѕ имени statistic +2. Установить зависимости РёР· файла requirements.txt +3. Далее надо выполнить следующую последовательность команд: + 1. flask db init + 2. flask db migrate + 3. flask db upgrade + +4. flask run + +## API + +| Путь | Описание | +| ----------- | ----------- | +| GET /api/v1/statistic | Получение статистики Р·Р° РІСЃРµ время | +| GET /api/v1/time | Получение текущего интервала | +| POST /api/v1/camera | Добавление новых источников РІ json (пример, {"ips" : ["vk.com"]}) | +| POST /api/v1/time?time= | Задание РЅРѕРІРѕРіРѕ интервала времени РІ секундах (РїРѕ умалчанию 3600) | +| DELETE /api/v1/camera | Удаление источников (пример, {"ips" : ["vk.com"]}) | +| POST /api/v1/scheduler/stop | Приостановление СЃР±РѕСЂР° статистики | +| POST /api/v1/scheduler/start | Возобновление СЃР±РѕСЂР° статистики | \ No newline at end of file