创建webhook并允许用户为其分配url
bambu-webhooks的Python项目详细描述
创建webhook并允许用户为其分配url
关于bambu webhooks
此软件包允许Web应用通过 网钩。作为开发人员,您可以按名称触发webhook,并且 提供一个界面,用户可以通过该界面管理url来发布 webhook的数据到。
关于BAMBU TOOLS 2.0
这是名为bambu tools的工具集的一部分。它是从一个 将bambu的命名空间及其所有 其他的工具。如果要从之前的版本升级 2.0,请确保更新代码以使用bambu_webhooks 而不是bambu.webhooks。
安装
通过pip安装软件包:
pip install bambu-webhooks
将其添加到您的INSTALLED_APPS列表:
INSTALLED_APPS = ( ... 'bambu_webhooks' )
将bambu_webhooks.urls添加到urlconf:
urlpatterns = patterns('', ... url(r'^webhooks/', include('bambu_webhooks.urls')), )
运行manage.py syncdb或manage.py migrate来设置数据库 桌子。
基本用法
在models.py文件中注册Webhook。
from hashlib import md5 import bambu_webhooks bambu_webhooks.site.register('webhook_name_', description = 'A description of the webhook' )
在模型的save()方法中,触发任何具有 附加接收者,从而将数据发布到用户的指定url。
def save(self, *args, **kwargs): ... bambu_webhooks.send('webhook_name_', self.author, { 'id': self.pk, 'name': self.name }, md5('testproject.myapp.mymodel:%d' % self.pk).hexdigest() )
最好使用引导
这个包是bambu工具集中最常用的一个 Bambu Bootstrap,一个 基于Web应用程序设计的灵活模板的集合 twitter引导框架。这不是包的要求,但是 表示模板结构和 观点更有意义。
待办事项
- 允许对webhook进行分类和/或筛选
- 准备国际化
- 编写测试
文档
完整的文档可以在 ReadTheDocs。
问题或建议?
在twitter(@iamsteadman)或visit my blog上找到我。