GitHub Webhooks Framework
Project description
Python GitHub Webhooks Framework
NOTE: Forked from github_webhooks as I needed to access query params from incoming webhooks for identification.
Simple and lightweight micro framework for quick integration with GitHub
webhooks.
It's based on FastAPI and pydantic, nothing more!
Async and mypy friendly.
Installation
Just add github-webhooks-framework
package.
Example:
pip install github-webhooks-framework
poetry add github-webhooks-framework
Example
Create file example.py
and copy next code:
import uvicorn
from pydantic import BaseModel
from github_webhooks import create_app
from github_webhooks.schemas import WebhookCommonPayload
# WebhookCommonPayload is based on pydantic.BaseModel
class PullRequestPayload(WebhookCommonPayload):
class Pull(BaseModel):
title: str
url: str
action: str
pull_request: Pull
# Initialize Webhook App
app = create_app()
# Register webhook handler:
# `pull_request` - name of an event to handle
# `PullRequestPayload` - webhook payload will be parsed into this model
@app.hooks.register('pull_request', PullRequestPayload)
async def handler(payload: PullRequestPayload) -> None:
print(f'New pull request {payload.pull_request.title}')
print(f' link: {payload.pull_request.url}')
print(f' author: {payload.sender.login}')
if __name__ == '__main__':
# start uvicorn server
uvicorn.run(app)
Let's have detailed overview.
We start by defining payload Model to parse incoming Pull Request Body.
class PullRequestPayload(WebhookCommonPayload):
class Pull(BaseModel):
title: str
url: str
action: str
pull_request: Pull
In this example we only want to get action
, pull_request.title
and pull_request.url
from payload.
By subclassing WebhookCommonPayload
model will automatically get sender
, repository
and organization
fields.
Next - we are creating ASGI app (based on FastAPI app)
app = create_app()
Optionally we can provide here secret_token
Github Webhook secret
app = create_app(secret_token='super-secret-token')
And time to define our handler
@app.hooks.register('pull_request', PullRequestPayload)
async def handler(payload: PullRequestPayload) -> None:
print(f'New pull request {payload.pull_request.title}')
print(f' link: {payload.pull_request.url}')
print(f' author: {payload.sender.login}')
We are using here @app.hooks.register
deco, which accepts 2 arguments:
event: str
- name of webhook eventpayload_cls: pydantic.BaseModel
- pydantic model class to parse request, subclassed frompydantic.BaseModel
orWebhookCommonPayload
.
And our handler function must be any of this signatures:
async def handler(payload: PullRequestPayload) -> None:
...
async def handler(payload: PullRequestPayload, headers: WebhookHeaders) -> Optional[str]:
# `headers` will be WebhookHeaders model with Github Webhook headers parsed.
...
An example setup can be found in example/server.py
.
References:
Development
- Install local venv:
python -m venv .venv
- Activate:
. .venv/bin/activate
- Install deps with
pip install -r requirements.txt -r requirements-test.txt
- When done with packages:
./freeze-requirements.sh
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for github-webhooks-framework2-0.1.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea80b0c3758b1c805ce7a705c93d9b79d049444f077e5e1460d9c602b6314d22 |
|
MD5 | 3dacf10f198147605a61b929b36aeaea |
|
BLAKE2b-256 | 528323335f731bc56fcad96aff46c2a70e71b1b8555529d53e29cb4e42c2ee3b |
Hashes for github_webhooks_framework2-0.1.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b43d71bace1f40661663b54b3038f349f2b53ec1a8134b127b63cd763eac4c1d |
|
MD5 | b3d3dde3fc347f619c99585c22c030f8 |
|
BLAKE2b-256 | 9503f65f559365b65a26c482960a0204e02db3fde452d879f7f02ecbf6185040 |