zulipbot 0.0.1

Initialization

Identify your Zulip bot’s email and API key, and make a new Bot object.

>>> import zulipbot
>>> email = 'foo@bar.baz'
>>> key = 'spammyeggs'
>>> my_bot = zulipbot.Bot(email, key)

Bot Methods

For an example on how the below methods work together in a program, check out example.py.

subscribe_to_all_streams - Subscribes to all Zulip streams.

send_private_message and send_stream_message both have the same parameters: message_info and content, i.e. the function signature for the two aforementioned methods is send_[[private||stream]]_message(message_info, content).

message_info is the message meta-info dictionary that you acquire from the function callback that processes messages. content is the response that you want your bot to make.