This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Create webhooks and allow users to assign URLs to them

Project Description

Create webhooks and allow users to assign URLs to them

About Bambu Webhooks

This package allows web apps to provide third-party integration via webhooks. You as the developer can trigger a webhook by name, and provide an interface whereby the user can manage the URL to post the webhook’s data to.

About Bambu Tools 2.0

This is part of a toolset called Bambu Tools. It’s being moved from a namespace of bambu to its own ‘root-level’ package, along with all the other tools in the set. If you’re upgrading from a version prior to 2.0, please make sure to update your code to use bambu_webhooks rather than bambu.webhooks.

Installation

Install the package via Pip:

pip install bambu-webhooks

Add it to your INSTALLED_APPS list:

INSTALLED_APPS = (
    ...
    'bambu_webhooks'
)

Add bambu_webhooks.urls to your URLconf:

urlpatterns = patterns('',
    ...
    url(r'^webhooks/', include('bambu_webhooks.urls')),
)

Run manage.py syncdb or manage.py migrate to setup the database tables.

Basic usage

Register a webhook within your models.py file.

from hashlib import md5
import bambu_webhooks

bambu_webhooks.site.register('webhook_name_',
    description = 'A description of the webhook'
)

In the save() method for your model, trigger any webhooks that have receivers attached, thus posting the data to the user’s specified 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()
    )

Better with Bootstrap

This package, among most in the Bambu toolset is designed to work with Bambu Bootstrap, a collection of flexible templates designed for web apps based on the Twitter Bootstrap framework. It’s not a package requirement, but it’ll mean the template structure and the context variables exposed by the view makes a little more sense.

Todo

  • Allow webhooks to be categorised and/or filtered
  • Prepare for internationalisation
  • Write tests

Documentation

Full documentation can be found at ReadTheDocs.

Questions or suggestions?

Find me on Twitter (@iamsteadman) or visit my blog.

Release History

Release History

This version
History Node

2.0

History Node

0.1

History Node

0.0.2

History Node

0.0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
bambu-webhooks-2.0.tar.gz (7.4 kB) Copy SHA256 Checksum SHA256 Source May 24, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting