Skip to content

bloomberg/python-github-webhook

GitHub Webhook (micro) Framework

PyPI

python-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

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

fromgithub_webhookimportWebhookfromflaskimportFlaskapp=Flask(__name__) # Standard Flask appwebhook=Webhook(app) # Defines '/postreceive' endpoint@app.route("/") # Standard Flask endpointdefhello_world(): return"Hello, World!"@webhook.hook() # Defines a handler for the 'push' eventdefon_push(data): print("Got push with:{0}".format(data)) if__name__=="__main__": app.run(host="0.0.0.0", port=80)

License

The python-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.

About

A framework for writing webhooks for GitHub, in Python.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 10

Languages