A Python GitHub Push WebHook Handler

GitHub offers a number of Service Hooks that trigger actions when someone pushes to your repository. The generic hook is a simple WebHook that you can easily handle on your server.

There is a official Rack handler somewhere, and maybe a Django one, but nothing in pure Python. So here is it.

It’s pretty simple and self-contained, start it with the IP address and port to listen on as arguments, and it will pass a function - handle_hook() - the payload received on each push as a Python dictionary. It also checks that the originating IP is actually GH.

Then simply enter the address of your server on the GH Service Hooks repo Admin page, and you’re all set.

The Webhooks admin page

For reference on what’s inside the payload, RTFM.

#!/usr/bin/env python #-*- coding:utf-8 -*- import BaseHTTPServer import sys import time import urlparse import json HOST_NAME = sys.argv[1] PORT_NUMBER = int(sys.argv[2]) def handle_hook(payload): pass class HookHandler(BaseHTTPServer.BaseHTTPRequestHandler): server_version = "HookHandler/0.1" def do_GET(s): s.send_response(200) s.wfile.write('Hello!') def do_POST(s): # Check that the IP is within the GH ranges if not any(s.client_address[0].startswith(IP) for IP in ('192.30.252', '192.30.253', '192.30.254', '192.30.255')): s.send_error(403) length = int(s.headers['Content-Length']) post_data = urlparse.parse_qs(s.rfile.read(length).decode('utf-8')) payload = json.loads(post_data['payload'][0]) handle_hook(payload) s.send_response(200) if __name__ == '__main__': server_class = BaseHTTPServer.HTTPServer httpd = server_class((HOST_NAME, PORT_NUMBER), HookHandler) print time.asctime(), "Server Starts - %s:%s" % (HOST_NAME, PORT_NUMBER) try: httpd.serve_forever() except KeyboardInterrupt: pass httpd.server_close() print time.asctime(), "Server Stops - %s:%s" % (HOST_NAME, PORT_NUMBER)

PyTux

Trips of a curious penguin.

A Python GitHub Push WebHook Handler