Skip to main content

The unofficial bot API for Zulip.

Project description

The unofficial Python API for Zulip bots. A Zulip email and API key are needed to use this.

To get your bot’s Zulip email and API key, go to your Settings page and scroll down to the Your Bots section.


To install: pip install zulipbot


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

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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zulipbot-0.0.1.tar.gz (6.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page