History

Steve Howell 5034220829 bots: Extract request_test_lib.py. The new module mocks out calls to the requests library, which is used by many of our bots that use third party services. Mocking of requests.py is mostly orthogonal to our other testing concerns.		2017-12-11 09:05:06 -06:00
..
zulip_bots	bots: Extract request_test_lib.py.	2017-12-11 09:05:06 -06: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	bots: Create Chess Bot.	2017-12-10 09:14:32 -06:00

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.