GitHub Webhook (micro) Framework

quart-github-webhook is a very simple, but powerful, microframework for writing GitHub webhooks in Python. It can be used to write webhooks for individual repositories or whole organisations, and can be used for GitHub.com or GitHub Enterprise installations; in fact, it was orginally developed for Bloomberg's GHE install.

Getting started

quart-github-webhook is designed to be as simple as possible, to make a simple Webhook that receives push events all it takes is:

from quart_github_webhook import Webhook
from quart import Quart

app = Quart(__name__)  # Standard Flask app, using Quart

# Defines the '/postreceive' endpoint
# you can also specify here: a github secret token, or a different endpoint URL
webhook = Webhook(app)

@app.route("/")        # Standard Flask endpoint
async def hello_world():
    return "Hello, World!"

@webhook.hook("push")        # Defines a handler for the 'push' event
async def on_push_event_receieved(data):
    print("Got push with: {0}".format(data))

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=80)

License

The quart-github-webhook repository is distributed under the Apache License (version 2.0); see the LICENSE file at the top of the source tree for more information.