Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mishankov/github-push-events-telegram-bot

Receive push events from GitHub repository in Telegram bot
https://github.com/mishankov/github-push-events-telegram-bot

bot docker fastapi github heroku python telegram webhook

Last synced: 12 days ago
JSON representation

Receive push events from GitHub repository in Telegram bot

Host: GitHub
URL: https://github.com/mishankov/github-push-events-telegram-bot
Owner: mishankov
License: gpl-3.0
Created: 2020-12-05T11:20:27.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2023-05-24T06:57:58.000Z (over 1 year ago)
Last Synced: 2024-04-15T01:57:26.377Z (9 months ago)
Topics: bot, docker, fastapi, github, heroku, python, telegram, webhook
Language: Python
Homepage:
Size: 67.4 KB
Stars: 8
Watchers: 2
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# GitHub push events Telegram bot

[![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)
[![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)

Receive `push` events from GitHub repository in Telegram bot

## Installation

Run `make install` for installation. If you don't have `make` installed, run commands from `install` action in `Makefile`

## Configuration

This application has some required and optional environment variables to set

### Required environment variables

- `TELEGRAM_BOT_TOKEN` - token of Telegram bot. [Documentation for Telegram bots](https://core.telegram.org/bots)
- `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

### Optional environment variables

- `GITHUB_WEBHOOK_SECRET` - secret part of your webhook URL. Default is `secret`
- `FASTAPI_OPENAPI_URL` - path to OpenAPI schema. More about that in [FastAPI documentation](https://fastapi.tiangolo.com/tutorial/metadata/). Empty by default

## Run application localy

Run `make run` to run application an your local machine. If you don't have `make` installed, run commands from `run` action in `Makefile`

## Run application on a server

To run application on a server you probably want to run something like this

```bash
gunicorn --chdir src main:app -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000
```

This whould run you application in port `8000`. More about that in [Gunicorn documentation](https://docs.gunicorn.org/en/stable/configure.html)

## Run with Docker

To run this application with docker use `docker run` command similar to this

```bash
docker run -p 8000:8000 -e TELEGRAM_BOT_TOKEN= -e TELEGRAM_CHAT_ID= -d mishankov/github-push-events-telegram-bot:latest
```

## Deploy to Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Cofigure GitHub webhook

Configure 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)