Giter Club home page Giter Club logo

radiogit's Introduction

RadioGit

A Python Bot - built upon the 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.

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.

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

radiogit's People

Contributors

avivace avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

pro-boys

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.