{"id":23080481,"url":"https://github.com/mishankov/github-push-events-telegram-bot","last_synced_at":"2025-08-15T22:30:55.084Z","repository":{"id":47146388,"uuid":"318769207","full_name":"mishankov/github-push-events-telegram-bot","owner":"mishankov","description":"Receive push events from GitHub repository in Telegram bot","archived":false,"fork":false,"pushed_at":"2023-05-24T06:57:58.000Z","size":69,"stargazers_count":8,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-15T01:57:26.377Z","etag":null,"topics":["bot","docker","fastapi","github","heroku","python","telegram","webhook"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mishankov.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}},"created_at":"2020-12-05T11:20:27.000Z","updated_at":"2023-06-16T20:26:52.000Z","dependencies_parsed_at":"2022-09-06T03:31:53.586Z","dependency_job_id":null,"html_url":"https://github.com/mishankov/github-push-events-telegram-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishankov%2Fgithub-push-events-telegram-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishankov%2Fgithub-push-events-telegram-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishankov%2Fgithub-push-events-telegram-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mishankov%2Fgithub-push-events-telegram-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mishankov","download_url":"https://codeload.github.com/mishankov/github-push-events-telegram-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229964396,"owners_count":18152034,"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":["bot","docker","fastapi","github","heroku","python","telegram","webhook"],"created_at":"2024-12-16T13:14:10.082Z","updated_at":"2024-12-16T13:14:10.554Z","avatar_url":"https://github.com/mishankov.png","language":"Python","readme":"# GitHub push events Telegram bot\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-black)](https://github.com/mishankov/github-push-events-telegram-bot/actions?query=workflow%3Ablack)\n[![CodeFactor](https://www.codefactor.io/repository/github/mishankov/github-push-events-telegram-bot/badge/main)](https://www.codefactor.io/repository/github/mishankov/github-push-events-telegram-bot/overview/main)\n\nReceive `push` events from GitHub repository in Telegram bot\n\n## Installation\n\nRun `make install` for installation. If you don't have `make` installed, run commands from `install` action in `Makefile`\n\n## Configuration\n\nThis application has some required and optional environment variables to set\n\n### Required environment variables\n\n- `TELEGRAM_BOT_TOKEN` - token of Telegram bot. [Documentation for Telegram bots](https://core.telegram.org/bots)\n- `TELEGRAM_CHAT_ID` - chat id to send messages to. Get it from [`@my_id_bot`](https://t.me/my_id_bot) in Telegram for example\n\n### Optional environment variables\n\n- `GITHUB_WEBHOOK_SECRET` - secret part of your webhook URL. Default is `secret`\n- `FASTAPI_OPENAPI_URL` - path to OpenAPI schema. More about that in [FastAPI documentation](https://fastapi.tiangolo.com/tutorial/metadata/). Empty by default\n\n## Run application localy\n\nRun `make run` to run application an your local machine. If you don't have `make` installed, run commands from `run` action in `Makefile`\n\n## Run application on a server\n\nTo run application on a server you probably want to run something like this\n\n```bash\ngunicorn --chdir src main:app -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000\n```\n\nThis whould run you application in port `8000`. More about that in [Gunicorn documentation](https://docs.gunicorn.org/en/stable/configure.html)\n\n## Run with Docker\n\nTo run this application with docker use `docker run` command similar to this\n\n```bash\ndocker run -p 8000:8000 -e TELEGRAM_BOT_TOKEN=\u003cTELEGRAM_BOT_TOKEN\u003e -e TELEGRAM_CHAT_ID=\u003cTELEGRAM_CHAT_ID\u003e -d mishankov/github-push-events-telegram-bot:latest\n```\n\n## Deploy to Heroku\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\n## Cofigure GitHub webhook\n\nConfigure GitHub repository to send events about push events to `/github/repository/webhook/{GITHUB_WEBHOOK_SECRET}/` path on your server. More about that in [GitHub webhooks documentation](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/about-webhooks)\n \n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmishankov%2Fgithub-push-events-telegram-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmishankov%2Fgithub-push-events-telegram-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmishankov%2Fgithub-push-events-telegram-bot/lists"}