Skip to content

Add Advanced Usage #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down