========================================== Sir Bot-a-lot | Asynchronous bot framework ========================================== This project aims to provide a simple library to generate bots for various services. The initial goal was to implement a bot for the slack team of the `pyslackers `_ community. Installation ------------ `Sir Bot-a-lot is on PyPI `_. .. code:: console $ pip3 install sirbot We recommend installing it in a `virtual environment `_. To run the bot initialize it and call the ``bot.start`` method: .. code:: python3 from sirbot import SirBot bot = SirBot() bot.start(host='0.0.0.0', port=80) For examples take a look at the :ref:`howto` and the `pyslackers bot `_. Plugins ------- Sir Bot-a-lot connect to services with plugins, some are bundled by default: * :class:`sirbot.plugins.github.GithubPlugin` For `Github `_. * :class:`sirbot.plugins.slack.SlackPlugin` For `Slack `_. * :class:`sirbot.plugins.postgres.PgPlugin` For `PostgreSQL `_. * :class:`sirbot.plugins.apscheduler.APSchedulerPlugin` For `APscheduler `_. * :class:`sirbot.plugins.readthedocs.RTDPlugin` For `Readthedocs `_. To load a plugin initialize it and call the ``bot.load`` method: .. code:: python3 from sirbot import SirBot from sirbot.plugins.slack import SlackPlugin bot = SirBot() slack = SlackPlugin(token='supersecureslacktoken') bot.load(slack) bot.start(host='0.0.0.0', port=80) Navigation ---------- .. toctree:: :maxdepth: 2 how_to/index api/index