toastbot

toastbot is a clean, extensible IRC bot using Python, irckit, gevent & requests.

Usage

Create your own ``bot.py`` file & drop in:

    import toastbot

    bot = toastbot.ToastBot('myircbot', '#myircchannel')
    bot.setup()

Then run it with ``python bot.py``.

Configuration

The ``Toastbot`` object requires ``nick`` & ``channel`` arguments & can take a
variety of non-required options.

Required arguments

* ``nick`` - The nickname of the bot, as a string.
* ``channel`` - The channel the bot should connect to, as a string.

Options

* ``server`` - The server the bot should connect to (default: ``irc.freenode.net``).
* ``username`` -The username the bot should identify as (default: ``nick``);
* ``realname`` - The human readable name the bot should provide (default: 'ToastBot').
* ``debug`` - Controls if the IRC connection should dump debug messages (default: ``false``).
* ``log_dir`` - Controls what directory the logs should go in (default: ``$INSTALL_DIRECTORY/logs``).
* ``variants`` - Used to override ways to address the bot. Should be strings (default: ``[self.nick+': ', self.nick+', ', self.nick+'- ', self.nick+' - ']``).

Requirements:

• Python
• gevent
• irckit
• requests