Mavenn Watchbot library for Google App Engine Python
Python
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
static
templates
tests
.gitignore
README.markdown
app.yaml
config.py
cron.yaml
fabfile.py
feedadmin.py
feedbot.py
feedpoller.py
index.yaml
main.py
models.py
queue.yaml
subscriber.py

README.markdown

This is an H1

This is a working implementation of a Mavenn stream bot framework for Google App Engine (GAE). You can use it to begin building your own bots. This framework is built to support many bots within a singl GAE application, but feel free to create a single GAE app for your bot if it warrants the resources and makes more sense that way.

A sample bot, feedbot, is included to show a fully functioning bot. This is the bot currently powering the Feed Streams on Mavenn.

Setup Google App Engine

Download and install the App Engine SDK

Register a new App Engine application

Prepare GAE Application

Clone this repository

Edit the app.yaml with your application name

Rename config.py.sample to config.py

Implement your bot

Create your models

Create Indexes

Edit cron.yaml

Deploy GAE Application

Test the GAE Appliction

To test your bot, you can use one of these handy web-based HTTP simulators to simulate your REST endpoints as the Mavenn engine will:

Register the bot on Mavenn

http://mavenn.com/springs/new

Update the bot endpoints on Mavenn accordingly. This framework handles routing for these endpoints.

Stream Resource URL: http://yourapp.appspot.com/yourbot

POST: http://yourapp.appspot.com/yourbot

PUT: http://yourapp.appspot.com/yourbot/stream-id

DELETE: http://yourapp.appspot.com/yourbot/stream-id

GET: http://yourapp.appspot.com/yourbot/stream-id.json

Clear the "append .json extension" checkbox

Leave the "Use POST with _method instead of DELETE or PUT" unchecked

Register the parameters your bot will accept

Get your API Key and Auth Token from Mavenn and update your config.py as needed

Publish your GAE app