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.

Usage

To install: pip install zulipbot

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.

Project details


Release history Release notifications

This version

0.0.1

Download files

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

Files for zulipbot, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size zulipbot-0.0.1.tar.gz (6.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page