History

Eeshan Garg e7e9059cb8 zulip_bots: Move installation of bot deps to tools/provision. A lot of these bot dependencies are pretty hefty and shouldn't be installed as part of the zulip_bots package. So the installation of these belongs in tools/provision, not in setup.py.		2018-06-04 20:01:53 -02:30
..
zulip_bots	zulip_bots: Remove unnecessary requirements.txt files in /bots.	2018-06-04 19:59:59 -02:30
architecture.md	zulip_bots: Update README.md.	2017-11-14 09:51:09 -08:00
README.md	zulip_bots: Consolidate game-playing bots.	2018-01-22 11:30:31 -05:00
setup.py	zulip_bots: Move installation of bot deps to tools/provision.	2018-06-04 20:01:53 -02: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.
│   ├───game_handler.py  # Handles game-related 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.
└───setup.py  # Script for packaging.