https://github.com/avivace/radiogit

Watch GitHub repositories from Telegram chats. GitHub notifications delivered on Telegram.
https://github.com/avivace/radiogit

bot broadcast-github git github github-api github-webhooks telegram telegram-api telegram-bot webhook-listener

Last synced: about 1 month ago
JSON representation

Watch GitHub repositories from Telegram chats. GitHub notifications delivered on Telegram.

• Host: GitHub
• URL: https://github.com/avivace/radiogit
• Owner: avivace
• License: gpl-3.0
• Created: 2017-02-06T11:49:54.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-01T11:47:04.000Z (almost 8 years ago)
• Last Synced: 2024-10-28T10:54:48.600Z (3 months ago)
• Topics: bot, broadcast-github, git, github, github-api, github-webhooks, telegram, telegram-api, telegram-bot, webhook-listener
• Language: Python
• Homepage:
• Size: 20.5 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RadioGit

A Python Bot - built upon the [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) wrapper and Node.js - to broadcast GitHub repository events and activities to Telegram chats.

Provides public interface, handles multiple users with multiple subscription to repositories.

Every user can add and remove his subscriptions.

A public instance of the bot is online at [@radiogit_bot](https://t.me/radiogit_bot).

## Overview

- The `webhoook-listener` contains a Node app to listen and record JSON payloads from GitHub;

- The `bot` folder contains the actual Telegram bot, which provides an user interface (allowing personal preferences) and delivers updates;

- In `misc` you'll find some other related code and the old PHP implementation of the webhook listening part (working but **deprecated**).

## Install

### Webhook Listener

**Dependencies**: Node.js (Express 4, body-parser)

Edit the port/webserver configuration and run `node index.js` (you may find useful setting up a reverse proxy). Make sure it's accessible and accepting POST requests, the URL will be the *Payload URL* when setting up the actual webhook in GitHub repository settings.

You can test the listener with `curl` with something like this: 

```

curl -d @payload.json -H "Content-Type: application/json" PAYLOAD/URL/SOME/POST

```

Assuming `payload.json` is something like [this](https://developer.github.com/v3/activity/events/types/#issuesevent).

### The actual bot

**Dependencies**: python3 (telegram, sqlite3).

Insert your bot token and run the bot with `python bot.py`

## Usage

When everything is ready, talk to the bot.

If the repository url is https://github.com/RepoOwner/RepoName, send `/sub RepoOwner/RepoName` to set up event subscription.

Works in groups, too.

## TODO

- Support other types of events (currently supporting only commit events, as POC);

- Implement *secret* checking;

- Conversation Handling;

- Rate Limitation;

- Message Templates;

### Related Projects

- [TeleGit](https://github.com/FruitieX/telegit)