History

Skunk 29e22c2c0a bots: Create Link Shortener Bot. Create Link Shortener Bot using the goo.gl Link Shortening API. Link Shortener Bot can be mentioned in a conversation, and it will respond with shortened, goo.gl links for every URL in the message. For example, > @link_shortener_bot @johnsmith Check out this file: > https://github.com/zulip/python-zulip-api/blob/master/zulip_bots/ and Link Shortener Bot would respond > https://github.com/zulip/python-zulip-api/blob/master/zulip_bots/: > https://goo.gl/Mt5z3c In order to use Link Shortener Bot, an API key for goo.gl must be set in `link_shortener.conf` in the `link_shortener` folder.		2017-12-05 06:08:30 -08:00
..
zulip_bots	bots: Create Link Shortener Bot.	2017-12-05 06:08:30 -08:00
architecture.md	zulip_bots: Update README.md.	2017-11-14 09:51:09 -08:00
generate_manifest.py	mypy: Add reported issue to 'type: ignore' line in generate_manifest.py.	2017-11-15 13:43:08 -08:00
README.md	Create terminal.py to run bots in the terminal.	2017-11-28 10:52:13 -08:00
setup.py	bots: Create Link Shortener Bot.	2017-12-05 06:08:30 -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.
│   ├───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.
├───generate_manifest.py  # Helper-script for packaging.
└───setup.py  # Script for packaging.