bot Namespace Reference

Module that sets up the Geometrize Twitter bot. More...

Functions
def	on_connect (api)
	Callback triggered when the stream listener connects. More...
def	on_timeout (api)
	Callback triggered when the stream listener times out. More...
def	on_error (api, code)
	Callback triggered when the listener encounters an error. More...
def	on_on_demand_status_event (api, status)
	Callback triggered when the stream listener for the Geometrize bot account reports a status event. More...
def	on_account_watcher_status_event (api, status)
	Callback triggered when the stream listener for tracking specific Twitter accounts reports a status event. More...
def	on_on_demand_filter_setup (stream)
	Callback triggered when setting up the stream filter for tracking the Geometrize bot account. More...
def	on_account_watcher_filter_setup (stream)
	Callback triggered when setting up the stream filter for tracking specific Twitter accounts. More...

Variables
	tweepy_auth = tweepy.OAuthHandler(config.OAUTH_CONSUMER_KEY, config.OAUTH_CONSUMER_SECRET)
	tweepy_api = tweepy.API(tweepy_auth)
	on_demand_bot
	account_watcher_bot

Detailed Description

Module that sets up the Geometrize Twitter bot.

Invoke this script to run the bot i.e. "python bot.py".

Function Documentation

on_account_watcher_filter_setup()

def bot.on_account_watcher_filter_setup

(

stream

)

Callback triggered when setting up the stream filter for tracking specific Twitter accounts.

def on_account_watcher_filter_setup(stream):
    print("Setting up account watcher tweet filter...")
    stream.filter(follow = config.TWITTER_BOT_WATCH_ACCOUNTS, is_async = True)
 
# Create and set up the on-demand Geometrize bot.
# This bot waits for users to tweet images at the bot, which it then geometrizes.

on_account_watcher_status_event()

def bot.on_account_watcher_status_event	(		api,
			status
	)

Callback triggered when the stream listener for tracking specific Twitter accounts reports a status event.

def on_account_watcher_status_event(api, status):
    print("Received Twitter stream listener status event")
    on_status_event.on_account_watcher_status_event(api, status)
 

Here is the call graph for this function:

on_connect()

def bot.on_connect

(

api

)

Callback triggered when the stream listener connects.

def on_connect(api):
    print("Twitter stream listener did connect")
 

on_error()

def bot.on_error	(		api,
			code
	)

Callback triggered when the listener encounters an error.

def on_error(api, code):
    print("Encountered Twitter error response: %s" % code)
    return True
 

on_on_demand_filter_setup()

def bot.on_on_demand_filter_setup

(

stream

)

Callback triggered when setting up the stream filter for tracking the Geometrize bot account.

def on_on_demand_filter_setup(stream):
    print("Setting up on demand tweet filter...")
    stream.filter(track = [config.TWITTER_BOT_USERNAME], is_async = True)
 

on_on_demand_status_event()

def bot.on_on_demand_status_event	(		api,
			status
	)

Callback triggered when the stream listener for the Geometrize bot account reports a status event.

def on_on_demand_status_event(api, status):
    print("Received Twitter stream listener status event")
    on_status_event.on_on_demand_status_event(api, status)
 

Here is the call graph for this function:

on_timeout()

def bot.on_timeout

(

api

)

Callback triggered when the stream listener times out.

def on_timeout(api):
    print("Twitter stream listener did time out")
    return False
 

Variable Documentation

account_watcher_bot

bot.account_watcher_bot

Initial value:

=  geometrize_bot.GeometrizeBot(
    tweepy_auth,
    tweepy_api,
    on_connect,
    on_timeout,
    on_error,
    on_account_watcher_status_event,
    on_account_watcher_filter_setup)

on_demand_bot

bot.on_demand_bot

Initial value:

=  geometrize_bot.GeometrizeBot(
    tweepy_auth,
    tweepy_api,
    on_connect,
    on_timeout,
    on_error,
    on_on_demand_status_event,
    on_on_demand_filter_setup)

tweepy_api

bot.tweepy_api = tweepy.API(tweepy_auth)

tweepy_auth

bot.tweepy_auth = tweepy.OAuthHandler(config.OAUTH_CONSUMER_KEY, config.OAUTH_CONSUMER_SECRET)