Skip to content
/ kaa Public
forked from maxcountryman/irctk

A simple, modular IRC bot written in Python using Gevent.

Notifications You must be signed in to change notification settings

octatone/kaa

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About

Kaa is a simple, modular IRC bot written in Python using Gevent.

Installation

Grab the source:

$ git clone git://github.com/maxcountryman/kaa.git

For now I recommend using pip to install to a virtualenv. The requirements.txt should get you set up. Note that you can exclude modules like bitly-api-python if you don't want or need URL shortening.

Writing a Plugin

Plugins are easy to write. Begin by importing the Plugin super class:

from voxbot.bot import Plugin

For convenience, Plugin provides a decorator for commands, @Plugin.command(). This should be used to assign a command to a function. It will return a tuple to your function. The first element of the tuple will be the command and the second will either be the command, if there are no args after the command, or the args that follow the command.

class MyPlugin(Plugin):
    '''usage: ^my_command [args]'''
    
    def __init__(self, bot)
        super(MyPlugin, self).__init__(bot)
        self.my_command()
        
    @Plugin.command('^my_command')
    def my_command(self, cmd, args):
        if args:
            self.reply(str(args))

Because the super class provides several shortcuts, such as reply(), it's often recommended to use super() to make sure these are available in your plugin class. Check out bot.py for a look at what's available.

In order to use the plugin you will need to save it to voxbot/plugins and add it to the list of configured plugins to load. Typically something like this should work, saved as config.py:

class Config(object):
    '''Settings for our bot.'''
    
    SETTINGS = {
        'server': 'irc.voxinfinitus.net', 
        'nick': 'Kaa', 
        'realname': 'Kaa the Python', 
        'port': 6697, 
        'ssl': True, 
        'channels': ['#testing'],
        'plugins': ['MyPlugin'],
        'owners': ['foobar']
    }

About

A simple, modular IRC bot written in Python using Gevent.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%