diff --git a/README.md b/README.md index 0f321c9..f816e3e 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,45 @@ if __name__ == "__main__": app.run(host="0.0.0.0", port=80) ``` +## Advanced Usage: + +``` +import os +from github_webhook import Webhook +from flask import Flask + +app = Flask(__name__) # Standard Flask app +webhook = Webhook(app, endpoint="/postreceive", secret='postreceivesecret') # 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)) + print(os.popen("sh ~/webhook.sh").read()) + +if __name__ == "__main__": + try: + port_number = int(sys.argv[1]) + except: + port_number = 8888 + app.run(host="0.0.0.0", port=port_number, debug=False) +``` + +If code is `webhook = Webhook(app, endpoint="/postreceive", secret='postreceivesecret')` and `port_number = 8888`: +Payload URL settting is resemble: http://yourwebsite:8888/postreceive +Secret settting is `postreceivesecret` + +If with no secret setting: +`webhook = Webhook(app, endpoint="/postreceive")` + + +If code is `webhook = Webhook(app)`: +it'll use default way: `/postreceive` + + ## License The `python-github-webhook` repository is distributed under the Apache License (version 2.0);