History

Rohitt Vashishtha 5c32054415 bots: Do not reply in group PMs unless explicitly mentioned. Previously, if a bot was accidentally added to a group PM, we would have no option but to leave that conversation because the bot would reply to all the messages sent in that conversation. This also has potential to cause infinite loops in case two bots are added to a group PM since they could keep on replying to each other's messages. Fixes #551.		2020-04-28 11:56:16 -04:00
..
zulip_bots	bots: Do not reply in group PMs unless explicitly mentioned.	2020-04-28 11:56:16 -04:00
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	pypi: Release version 0.7.0.	2020-04-20 23:23:58 -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.