{"id":28158044,"url":"https://github.com/fourex/alerts_in_ua.py-presentation","last_synced_at":"2025-07-14T04:14:09.800Z","repository":{"id":221211704,"uuid":"753749355","full_name":"FOUREX/alerts_in_ua.py-presentation","owner":"FOUREX","description":"Презентація бібліотеки Alerts-in-ua.py","archived":false,"fork":false,"pushed_at":"2024-02-11T03:29:34.000Z","size":930,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-02-12T03:22:51.708Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FOUREX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-06T18:10:23.000Z","updated_at":"2024-02-12T03:22:51.708Z","dependencies_parsed_at":"2024-02-11T03:22:17.547Z","dependency_job_id":"07954984-e07f-47b6-a2cb-9f7e313da916","html_url":"https://github.com/FOUREX/alerts_in_ua.py-presentation","commit_stats":null,"previous_names":["fourex/alerts_in_ua.py-presentation"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FOUREX%2Falerts_in_ua.py-presentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FOUREX%2Falerts_in_ua.py-presentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FOUREX%2Falerts_in_ua.py-presentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FOUREX%2Falerts_in_ua.py-presentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FOUREX","download_url":"https://codeload.github.com/FOUREX/alerts_in_ua.py-presentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254310484,"owners_count":22049470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-15T09:15:59.010Z","updated_at":"2025-05-15T09:17:35.957Z","avatar_url":"https://github.com/FOUREX.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Приклади використання бібліотеки `Alerts-in-ua.py`\n\n## Перед початком роботи\n**Потрібен Python 3.10 і вище.**\n\nСтворіть та активуйте віртуальне середовище за допомогою наступних команд:\n\n```shell\n# Створення віртуального середовища\npython -m venv venv\n\n# Активація віртуального середовища\nvenv\\Scripts\\activate\n```\n\nСтворіть `.env` файл в корені проекту в якому будуть зберігатися токени:\n```dotenv\nALERTS_CLIENT_TOKEN=token\nTELEGRAM_BOT_TOKEN=token\n```\n\nДля роботи програм необхідно встановити залежності наступною командою:\n\n```sh\npip install -r requirements.txt\n```\n\n\n## CLI client\n**Перейдіть в директорію `\"CLI client\"`**\n\nВиведення тривог на даний момент (звичайний режим). Використання параметрів не обов'язкове. Приклад використання:\n```shell\npy alerts.py\n```\n\n### Параметри\n- `-h`, `--help` - Виведення списку доступних параметрів.\n- `monitor` - Режим монітора. Дані будуть оновлюватися автоматично декілька раз на хвилину.\n- `-freq`, `--frequency` - Задає частоту оновлень даних в режимі монітора за хвилину.\n- `-f`, `--format` - Список атрибутів локацій які будуть відображені в списку.\n- `--show-image` - Відображення мапи тривог (не працює в режимі монітора).\n- `--save-image` - Зберігає мапу тривог як зображення в директорію .\\saves\n\n### Приклади\n\nЗміна частоти оновлення даних в режимі монітора параметрами `-freq`, `--frequency`:\n```shell\npy alerts.py monitor -freq 4\n```\n\nЗміна даних для відображення параметрами `-f`, `--format`. Доступні параметри дивитися\nна [сайті](https://devs.alerts.in.ua/#modelalert) (назва поля). Приклад використання:\n```shell\npy alerts.py monitor -f \"started_at\" \"location_title\" \"location_oblast\" \"location_uid\"\n```\n\nЗбереження мапи тривог параметром `--save-image`, наступне зображення зберігається тільки при змінах:\n```shell\npy alerts.py --save-image\n```\n\n### Загальний вигляд\n\nРежим монітору з частотою оновлення 4 рази на хвилину та індивідуальним форматом:\n```shell\npy alerts.py monitor -freq 4 -f \"started_at\" \"location_title\" \"location_oblast\" \"location_uid\"\n```\n\n![](assets/CLI%20client%20example.png)\n\nВідображення мапи тривог - одна з особливостей даної бібліотеки:\n```shell\npy alerts.py --show-image\n```\n\n![](assets/Show%20image%20example.png)\n\n# Telegram бот\n**Перейдіть в директорію `\"telegram bot\"`**\n\nДля запуску бота скористайтеся командою:\n```shell\npy main.py\n```\n\nПриклад мапи тривог в Telegram боті. Використовуйте команду `/alerts`:\n![](assets/Telegram%20bot%20example.png)\n\n# Сайт\n**Перейдіть в директорію `\"site\"`**\n\nДля запуску сайту використовуйте команду:\n```shell\nflask run --host=127.0.0.1 --port=25585\n```\n\nВигляд сайту з мапою та списком тривог\n![](/assets/Site%20example.png)\n\n# Додатково\n\nПриклад Telegram бота: https://t.me/alerts_in_ua_dot_py_bot\n\nПриклад сайту: http://91.199.45.219:25585\n\nДокументація API: https://devs.alerts.in.ua/\n\nРепозиторій бібліотеки: https://github.com/FOUREX/alerts_in_ua.py\n\nPyPi бібліотеки: https://pypi.org/project/alerts-in-ua.py/\n\nTelegram канал для обговорень: https://t.me/Alerts_in_ua_dot_py\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffourex%2Falerts_in_ua.py-presentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffourex%2Falerts_in_ua.py-presentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffourex%2Falerts_in_ua.py-presentation/lists"}