Commit db33fd52 authored by Рудакова Ольга Сергеевна's avatar Рудакова Ольга Сергеевна
Browse files

add readme.md

parent f1e55b5d
No related merge requests found
Showing with 29 additions and 0 deletions
+29 -0
readme.md 0 → 100644
## Информация о приложении
Приложение используется для сбора статистики 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
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment