https://github.com/jcarbaugh/django-breakroom

A Django implementation of Watercoolr, http://watercoolr.nuklei.com/, a Ruby webhooks application.
https://github.com/jcarbaugh/django-breakroom

Last synced: 2 months ago
JSON representation

A Django implementation of Watercoolr, http://watercoolr.nuklei.com/, a Ruby webhooks application.

• Host: GitHub
• URL: https://github.com/jcarbaugh/django-breakroom
• Owner: jcarbaugh
• Created: 2010-04-09T20:48:55.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2010-04-09T20:49:07.000Z (over 14 years ago)
• Last Synced: 2024-08-05T15:05:41.359Z (5 months ago)
• Language: Python
• Homepage:
• Size: 80.1 KB
• Stars: 14
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# django-breakroom

django-breakroom is a Django implementation of [Watercoolr](http://watercoolr.nuklei.com/), a Ruby webhooks application.

## Requirements

python >= 2.5

django >= r10650

## Installation

To install run

    python setup.py install

which will install the application into python's site-packages directory.

Add to INSTALLED_APPS:

	'breakroom',

Add to urls.py:

	url(r'^path/to/breakroom/', include('breakroom.urls')),

## Usage

The following usage examples were taken from the [Watercoolr](http://watercoolr.nuklei.com/) web site.

### Create a channel

	→ POST /channels

	← { 'id': '2d0128d' }

### Add subscribers

	→ POST /subscribers data={ 'channel':'2d0128d', 'url':'http://api.otherservice.com/your-message-handler' }

	← { 'status': 'OK' }

### Post messages

	you → POST /messages data={ 'channel':'2d0128d', 'message':'hey guys!' }

	   us → POST http://api.otherservice.com/your-message-handler data='hey guys!'

	   ...for every subscriber...

	← { 'status': 'OK' }