dj-webhooks 0.2.1

需求

• Python 2.7.x 或 3.3.2 或更高版本

• django>=1.5.5

• django-jsonfield>=0.9.12

• django-model-utils>=2.0.2

• django-rq>=0.6.1

• webhooks>=0.3.1

快速入门

安装dj-webhooks

pip install dj-webhooks

配置一些Webhook事件

# settings.py
WEBHOOK_EVENTS = (
    "purchase.paid",
    "purchase.refunded",
    "purchase.fulfilled"
)

添加一些Webhook目标

from django.contrib.auth import get_user_model
User = get_user_model()
user = User.objects.get(username="pydanny")

from webhooks.models import Webhook
WebhookTarget.objects.create(
    owner=user,
    event="purchase.paid",
    target_url="https://mystorefront.com/webhooks/",
    header_content_type=Webhook.CONTENT_TYPE_JSON,
)

然后在项目中使用它

from django.contrib.auth import get_user_model
User = get_user_model()
user = User.objects.get(username="pydanny")

from djwebhooks.decorators import hook

from myproject.models import Purchase

# Event argument helps identify the webhook target
@hook(event="purchase.paid")
def send_purchase_confirmation(purchase, owner): # Webhook_owner also helps identify the webhook target
    return {
        "order_num": purchase.order_num,
        "date": purchase.confirm_date,
        "line_items": [x.sku for x in purchase.lineitem_set.filter(inventory__gt=0)]
    }

for purchase in Purchase.objects.filter(status="paid"):
    send_purchase_confirmation(purchase=purchase, owner=user)

在队列中使用django-rq

假设您正在运行Redis并且已经配置了django-rq

from django.contrib.auth import get_user_model
User = get_user_model()
user = User.objects.get(username="pydanny")

# import redis hook
from djwebhooks.decorators import redis_hook

from myproject.models import Purchase

# Event argument helps identify the webhook target
@redis_hook(event="purchase.paid")
def send_purchase_confirmation(purchase, owner): # Webhook_owner also helps identify the webhook target
    return {
        "order_num": purchase.order_num,
        "date": purchase.confirm_date,
        "line_items": [x.sku for x in purchase.lineitem_set.filter(inventory__gt=0)]
    }

for purchase in Purchase.objects.filter(status="paid"):
    job = send_purchase_confirmation(purchase=purchase, owner=user)

特性

• 同步Webhook

• 通过Django ORM进行投递跟踪。

• 异步Webhook的选项。

计划中的特性

• 通过Redis和其他快速写数据存储进行投递跟踪。

历史