History

LoopThrough-i-j f56f824676 zulip-bots: Replace `ExternalBotHandler` type by `BotHandler`. The functions `extract_query_without_mention` and `is_private_message_but_not_group_pm` now accept `BotHandler` instead of `ExternalBotHandler` which allows passing objects of both `EmbeddedBotHandler` and `ExternalBotHandler`. Fixes #639		2021-03-03 13:31:59 -08:00
..
zulip_bots	zulip-bots: Replace `ExternalBotHandler` type by `BotHandler`.	2021-03-03 13:31:59 -08: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	zulip-bots: Add `BotStorage` Protocol.	2021-03-03 13:30:55 -08: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.
│   ├───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.