History

Steve Howell 043d963a99 Fail fast for bad connections with the API and bots. The API has aggressive retry logic for connecting to a server, which may make sense for situation where you have connection blips or server restarts. When you're first connecting to the API, however, connection failures are almost certainly a sign of misconfiguration, so now we fail fast. The bot lib takes advantage of this API change by catching the ZulipError exception and exiting gracefully.		2017-11-21 14:21:04 -08:00
..
zulip_bots	Fail fast for bad connections with the API and bots.	2017-11-21 14:21:04 -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	zulip_bots: Update links to docs.	2017-11-16 13:54:02 +01:00
setup.py	mypy: zulip_bots: Fix errors in setup.py.	2017-10-27 00:56:15 -04: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.
│   ├───test_lib.py  # Backbone for bot unit tests.
│   ├───test_run.py  # Unit tests for run.py
│   └───zulip_bot_output.py  # Used to test bots in the command line.
├───generate_manifest.py  # Helper-script for packaging.
└───setup.py  # Script for packaging.