Welcome to spate-python’s documentation!

Quickstart

Installation

Installation is done using pip

$ pip install spate

If you want the latest possible version, grab it directly from the git repo. However, be careful as this may be broken.

$ pip install git+https://github.com/spateio/spate-python.git

Usage

import spate
client = spate.Spate('app_key', 'app_secret')
client.push('Example message', ['channel1', 'second_channel'])

class spate.Spate(app_key, app_secret)

push(message, channels)

Pushes message to all channels

Parameters:

• message – string
• channels – list

sign(message)

Returns a signature made using an app’s secret key

classmethod from_url(url)

Returns a Spate object when given a URL of the format https://<app_key>:<app_secret>@api.spate.io