History

xenofem d9c2ae4068 rollcake: fate dice		2023-04-03 20:39:42 -04:00
..
zulip_bots	rollcake: fate dice	2023-04-03 20:39:42 -04:00
README.md	bots: Migrate source file for zulip-bot-shell to similar name.	2021-11-21 21:06:40 -08:00
architecture.md	zulip_bots: Update README.md.	2017-11-14 09:51:09 -08:00
setup.py	Remove Python 3.6; add Python 3.10.	2023-01-24 12:04:59 -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
│   └───bot_shell.py  # Used to test bots in the command line.
└───setup.py  # Script for packaging.