GitXplorerGitXplorer
l

revere

public
9 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
83022e7dcfe9c96f69608c3efcc552a999adbc2e

Simple broadcasting works

llyndsysimon committed 12 years ago
Unverified
b0c5fd98f4f72ea1e5f6a105ef31ca0395b059b1

Adds PyCharm IDE files to .gitignore

llyndsysimon committed 12 years ago
Unverified
88f530121ef02786b292e2da0e12e10b1eb36182

reST correction

llyndsysimon committed 12 years ago
Unverified
7457b7fcb01ef9fc90f6e2894c3c1ee9d92836f0

Adds requirements

llyndsysimon committed 12 years ago
Unverified
0405875e3b89b9f73bcc34486fd21c5fe3cf8064

Adds .gitignore

llyndsysimon committed 12 years ago
Unverified
c9636831c38dafa46f586960e8bd045a84ddd914

Adds readme

llyndsysimon committed 12 years ago

README

The README file for this repository.

============================= Revere: Streaming Event API

Overview

Revere is intended to be used as a relay point, accepting inbound notifications via HTTP and relaying them in JSON format to clients via Websockets.

Requirements

Revere supports Python 3.3. Additional requirements may be be found in the requirements.txt.

Client API

Each event notification will contain the following elements:

+------------+---------------+------------------------------------+ | Element | Type | Content | +============+===============+====================================+ | id | String | unique ID, alphanumeric, | | | | up to 32 characters | +------------+---------------+------------------------------------+ | category | String | The type of event; clients may use | | | | this for specific handling actions | +------------+---------------+------------------------------------+ | timestamp | UTC Timestamp | when the event occured | +------------+---------------+------------------------------------+ | priority | int; 0<=x<=5 | Relative importance, 5 being most | | | | important and 0 being | | | | informational only | +------------+---------------+------------------------------------+ | text | String | The text to be displayed | +------------+---------------+------------------------------------+