History

PIG208 e27ac0ddbe pyupgrade: Replace `Text` with `str`. We uses `pyupgrade --py3-plus` to automatically replace all occurence of `Text`. But manual fix is required to remove the unused imports. Note that with this configuration pyupgrade also convert string literals to .format(...) style, which is manually not included in the commit as well.		2021-06-02 18:45:57 -07:00
..
zulip_bots	pyupgrade: Replace `Text` with `str`.	2021-06-02 18:45:57 -07: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	black: Reformat without skipping string normalization.	2021-06-02 18:45:57 -07: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.