{"id":21887217,"url":"https://github.com/profcomff/aciniformes-project","last_synced_at":"2025-06-15T10:37:46.142Z","repository":{"id":140996390,"uuid":"593175111","full_name":"profcomff/aciniformes-project","owner":"profcomff","description":"Ping service","archived":false,"fork":false,"pushed_at":"2024-10-09T12:17:14.000Z","size":78,"stargazers_count":12,"open_issues_count":12,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-28T18:55:14.978Z","etag":null,"topics":["internal-service"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"dyakovri/aciniformes-project","license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/profcomff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"publiccode":null,"codemeta":null}},"created_at":"2023-01-25T12:17:21.000Z","updated_at":"2024-12-07T20:51:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"cc802325-9ac9-48e4-a769-c92289f7d5bd","html_url":"https://github.com/profcomff/aciniformes-project","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Faciniformes-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Faciniformes-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Faciniformes-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Faciniformes-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/profcomff","download_url":"https://codeload.github.com/profcomff/aciniformes-project/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249048711,"owners_count":21204305,"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":["internal-service"],"created_at":"2024-11-28T11:08:49.867Z","updated_at":"2025-04-15T09:50:20.096Z","avatar_url":"https://github.com/profcomff.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aciniformes-project\n\nПроект пингера сервисов профкома ФФ МГУ. Позволяет пользователю просто и быстро проверять работоспособность любого сайта и сервиса и получать отчет через telegram бота.\n\n[\u003cimg src=\"https://cdn.profcomff.com/easycode/easycode.svg\" width=\"200\"\u003e\u003c/img\u003e](https://easycode.profcomff.com/templates/docker-fastapi/workspace?mode=manual\u0026param.Repository+URL=https://github.com/profcomff/aciniformes-project.git\u0026param.Working+directory=pinger-api)\n\n# Функционал\n\n1. Опрос любого сервиса или сайта на работоспособность\n2. Создание расписания проверок указанных сайтов/сервисов\n3. Получение удобного отчета о проверке через telegram бота\n\n# Разработка\nBackend разработка – https://github.com/profcomff/.github/wiki/%5Bdev%5D-Backend-разработка\n\n\n# Quick Start\n1. Перейдите в папку проекта\n\n2. Создайте виртуальное окружение командой:\n`foo@bar:~$ python3 -m venv ./venv/`\n3. Установите библиотеки командой:\n`foo@bar:~$ pip install -m requirements.txt`\n4. Установите все переменные окружения (см. CONTRIBUTING.md)\n5. Запускайте приложение!\n`foo@bar:~$ python -m services-backend`\n\n\n# Использование\n## Настройка сервиса через Docker Compose\n```yml\nversion: '3.8'\n\nservices:\n  postgres:\n    image: postgres:14\n    restart: always\n    volumes:\n      - postgres:/var/lib/postgresql/data\n    environment:\n      POSTGRES_USER: pinger\n      POSTGRES_PASSWORD: qwerty123\n\n  backend:\n    image: ghcr.io/profcomff/aciniformes-project:latest\n    restart: always\n    ports:\n      - 80:80\n    depends_on:\n      - postgres\n      - migration\n    environment:\n      - DB_DSN=postgresql://pinger:qwerty123@postgres:5432/postgres\n      - AUTH_URL=https://api.profcomff.com/auth\n\n  pinger:\n    image: ghcr.io/profcomff/aciniformes-project:latest\n    restart: always\n    depends_on:\n      - postgres\n      - migration\n    environment:\n      - DB_DSN=postgresql://pinger:qwerty123@postgres:5432/postgres\n      - AUTH_URL=https://api.profcomff.com/auth\n    command: python -m aciniformes_project worker\n\nvolumes:\n  postgres:\n```\n\n## API запросы\n1. Создание получателя сообщений\n   1. Получить или узнать токен telegram бота, через которого будет посылаться сообщение\n   2. Узнать id чата-получателя в telegram\n   3. Создать получателя сообщений, выполнив запрос POST /receiver с телом: `{\"url\": \"https://api.telegram.org/bot{токен_бота}/sendMessage\", \"method\": \"post\", \"receiver_body\": {\"chat_id\": id_получателя, \"text\": текст_сообщения}`\n\n2. Создание опрашиваемого сервиса\n   1. Выполнить запрос POST /fetcher с телом: `\"{\n  \"type_\": \"get/post/ping\",\n  \"address\": \"ссылка на опрашиваемый сайт\",\n  \"fetch_data\": \"{}\" (Имеет смысла заполнять только если в type_ указан post запрос),\n  \"delay_ok\": частота опроса при успешном запросе,\n  \"delay_fail\": частота опроса при неудавшемся запросе\n}\"`\n\n# Параметризация и плагины\nBOT_TOKEN - токен бота-отправителя отчетов\n\n# Ссылки\nДокументация проекта - https://api.test.profcomff.com/?urls.primaryName=pinger#\nBackend разработка – https://github.com/profcomff/.github/wiki/%5Bdev%5D-Backend-разработка\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Faciniformes-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprofcomff%2Faciniformes-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Faciniformes-project/lists"}