Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tizz98/webhook-utils
Webhook utilities
https://github.com/tizz98/webhook-utils
python-webhook python3 webhooks
Last synced: 9 days ago
JSON representation
Webhook utilities
- Host: GitHub
- URL: https://github.com/tizz98/webhook-utils
- Owner: tizz98
- Created: 2021-12-29T19:47:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-08T13:17:46.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T21:48:27.278Z (about 1 month ago)
- Topics: python-webhook, python3, webhooks
- Language: Python
- Homepage:
- Size: 145 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Webhook Utils
A set of utilities for interacting with [webhooks](https://webhooks.dev).
[](https://github.com/tizz98/webhook-utils/actions/workflows/main.yaml)
[](https://github.com/psf/black)
[](https://github.com/tizz98/py-paas/tree/main/LICENSE)
[](https://codecov.io/gh/tizz98/webhook-utils)
[](https://pypi.python.org/pypi/webhook-utils/)
[Installation](#installation) | [Usage](#usage) | [HTTPX](#httpx) | [FastAPI](#fastapi) | [Contributing](CONTRIBUTING.md) | [End-to-End Examples](./examples/README.md)
## Installation
```shell
pip install webhook-utils
```
## Usage
### Crypto
Available hash algorithms for all methods are:
- `md5` (not recommended)
- `sha1`
- `sha256` (recommended)
Learn more about HMAC signatures [here](https://webhooks.dev/docs/auth/#hmac).
#### Generating HMAC signatures
Bare usage:
```python
from webhook_utils.crypto import generate_sha256_signature
print(generate_sha256_signature(b'secret-key', b'some-message'))
```
#### Comparing HMAC signatures
Bare usage:
```python
from webhook_utils.crypto import compare_sha256_signature
is_valid_signature = compare_sha256_signature(
b'secret-key',
b'some-message',
'expected-signature',
)
if not is_valid_signature:
raise ValueError('Invalid signature')
```
### Httpx
`webhook-utils` has a built-in `httpx.Auth` class that can be used to
automatically sign requests made with an `httpx.Client`.
An `X-Webhook-Signature` header will be added to all `POST` requests.
The signature will be generated using the `webhook_key` and the
provided signature method (defaults to `sha256`).
The header, signature, and http methods can be customized by passing
the `header_name`, `gen_signature_method`, and `methods` keyword arguments.
```shell
pip install webhook-utils[httpx]
```
```python
import httpx
from webhook_utils.contrib.httpx_auth import WebhookAuth
from webhook_utils.crypto import generate_sha1_signature
# Basic usage
auth = WebhookAuth("secret-key")
client = httpx.Client(auth=auth)
# Customized usage
auth = WebhookAuth(
"secret-key",
header_name="My-Webhook-Signature",
gen_signature_method=generate_sha1_signature,
methods={"POST", "PUT"},
)
client = httpx.Client(auth=auth)
client.post("https://example.com/webhook", json={"foo": "bar"})
```
### FastAPI
`webhook-utils` has a built-in `WebhookRouter` class that can be used to
wrap a `fastapi.APIRouter` to automatically verify incoming request signatures.
```shell
pip install webhook-utils[fastapi]
```
```python
from fastapi import FastAPI, APIRouter
from webhook_utils.contrib.fastapi import WebhookRouter
app = FastAPI()
webhook_router = WebhookRouter(
APIRouter(prefix="/webhooks"),
webhook_key="secret",
)
@webhook_router.on("/demo-webhook")
def demo_event_handler():
return {"status": "ok"}
app.include_router(webhook_router.api_router)
```
## Publishing to PYPI
```shell
poetry build
# Verify that everything looks correct on test.pypi.org
poetry publish -r testpypi
poetry publish
```