Skip to main content

Yet another IRC bot library

Project description

Flattr this repo

FatBotSlim

Yet another Python IRC bot library…

Features:

  • asynchronous
  • multi-server
  • easy to use plugin system
  • rights management for user-defined commands
  • automated help messages generation for custom plugins
  • colored logging
  • colored IRC messages
  • command line parser to set your custom bot settings from the console

Dependencies:

  • gevent
  • chardet

Installation:

  • From GitHub:

    git clone https://github.com/mattoufoutu/fatbotslim.git
    cd fatbotslim
    python setup.py install
    
  • From PyPI:

    pip install fatbotslim
    

Documentation:

The documentation is hosted on readthedocs and is available in the following formats:

Example:

This very simple bot answers Hello <username>! when someone says !hello in a public message.

Using the fatbotslim.cli helpers also gives your bot an integrated command line arguments parser.

For more detailed informations about writing custom handlers and more complex bots, please refer to the documentation.

from fatbotslim.cli import make_bot, main
from fatbotslim.handlers import CommandHandler, EVT_PUBLIC

class HelloCommand(CommandHandler):
    triggers = {
        'hello': [EVT_PUBLIC],
    }

    def hello(self, msg):
        self.irc.msg(msg.dst, "Hello {0}!".format(msg.src.name))

bot = make_bot()
bot.add_handler(HelloCommand)
main(bot)

Just try it!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
FatBotSlim-0.2.tar.gz (14.4 kB) Copy SHA256 hash SHA256 Source None Sep 21, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page