History

derAnfaenger 761e3e5855 zulip_bots: Update README.md. This stubs the zulip_bots README.md and moves architectural information to architecture.md.		2017-11-14 09:51:09 -08:00
..
zulip_bots	zulip_bots: Remove redundant custom tests in encrypt.	2017-11-14 09:39:00 -08:00
architecture.md	zulip_bots: Update README.md.	2017-11-14 09:51:09 -08:00
generate_manifest.py	mypy: zulip_bots: Fix errors in setup.py.	2017-10-27 00:56:15 -04:00
README.md	zulip_bots: Update README.md.	2017-11-14 09:51:09 -08: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.