https://github.com/bloomberg/python-github-webhook

A framework for writing webhooks for GitHub, in Python.
https://github.com/bloomberg/python-github-webhook

Last synced: 5 days ago
JSON representation

A framework for writing webhooks for GitHub, in Python.

• Host: GitHub
• URL: https://github.com/bloomberg/python-github-webhook
• Owner: bloomberg
• License: apache-2.0
• Created: 2016-01-29T21:22:48.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T16:17:08.000Z (3 months ago)
• Last Synced: 2024-06-18T21:31:41.081Z (9 days ago)
• Language: Python
• Homepage: https://bloomberg.github.io/python-github-webhook
• Size: 190 KB
• Stars: 285
• Watchers: 9
• Forks: 70
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-stars - python-github-webhook - A framework for writing webhooks for GitHub, in Python. (Python)

README

        
# GitHub Webhook (micro) Framework

[![PyPI](https://img.shields.io/pypi/v/github-webhook.svg)][2]

`python-github-webhook` is a very simple, but powerful, microframework for writing [GitHub

webhooks][1] 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:

```py

from github_webhook import Webhook

from flask import Flask

app = Flask(__name__)  # Standard Flask app

webhook = Webhook(app) # Defines '/postreceive' endpoint

@app.route("/")        # Standard Flask endpoint

def hello_world():

    return "Hello, World!"

@webhook.hook()        # Defines a handler for the 'push' event

def on_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.

[1]: https://developer.github.com/webhooks/

[2]: https://pypi.python.org/pypi/github-webhook