mostr-zulip-bot/zulip_bots/README.md
Anders Kaseorg f78e6e653b Remove remnants of bots_unmaintained.
This was deleted in commit 754a9f7880
(#567).

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-11-13 13:29:50 -08:00

971 B

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.
│   ├───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
│   └───bot_shell.py  # Used to test bots in the command line.
└───setup.py  # Script for packaging.