History

Steve Howell 6087cf95e2 bot tests: Use StubBotTestCase in tictactoe. Note that we now only have one conversation, since the case of sending to streams has the same mechanics as sending PMs. We'll eventually want a separate test to drive out differences in the actual mechanics of the reply.		2017-12-01 07:00:20 -08:00
..
zulip_bots	bot tests: Use StubBotTestCase in tictactoe.	2017-12-01 07:00:20 -08:00
architecture.md	zulip_bots: Update README.md.	2017-11-14 09:51:09 -08:00
generate_manifest.py	mypy: Add reported issue to 'type: ignore' line in generate_manifest.py.	2017-11-15 13:43:08 -08:00
README.md	Create terminal.py to run bots in the terminal.	2017-11-28 10:52:13 -08:00
setup.py	packaging: Upgrade to release 0.3.9.	2017-11-29 01:23:12 -03:30

README.md

Zulip bots

This directory contains the source code for the zulip_bots PyPI package.

The Zulip documentation has guides on using Zulip's bot system and writing your own bots.

Directory structure

zulip_bots  # This directory
├───zulip_bots  # `zulip_bots` package.
│   ├───bots/  # Actively maintained and tested bots.
│   ├───bots_unmaintained/  # Unmaintained, potentially broken bots.
│   ├───lib.py  # Backbone of run.py
│   ├───provision.py  # Creates a development environment.
│   ├───run.py  # Used to run bots.
│   ├───simple_lib.py  # Used for terminal testing.
│   ├───test_lib.py  # Backbone for bot unit tests.
│   ├───test_run.py  # Unit tests for run.py
│   └───terminal.py  # Used to test bots in the command line.
├───generate_manifest.py  # Helper-script for packaging.
└───setup.py  # Script for packaging.