kylef-archive / znc-bot

A python3 bot (znc module)

znc-bot

znc-bot depends on a recent development build of ZNC compiled with modpython.

Installation

To install znc-bot you can copy the source files onto your znc modules directory, which can usually be found at ~/.znc/modules or /usr/lib/znc/modules.

Loading

Loading znc-bot

/msg *status loadmod bot

Once the core bot has been loaded you can load any included plugins.

/msg *status loadmod security
/msg *status loadmod rand

Bot API

from bot.api import *

class helloworld(Module):
    @command
    def hi(self, event, args):
        return "Hello there!"

Asyncronous HTTP

from bot.api import *

class trakt(Module):
    @command
    @http
    def trending(self, event, string):
        event.http('http://api.trakt.tv/movies/trending.json/my-api-key')

    @trending.http(200)
    def handle_trending(self, event, response):
        for movie in movies.json:
            event.write('{title} ({year}) - {overview}'.format(**movie)) 

znc-bot's Issues

Periodic tasks

@interval(10) # run every 10 seconds
@http
def do_something(event, *args):
    event.http('http://some-url.com/my-thing')

@do_something.http(200)
def handle_something(event, response):
    pass

the http bit is just one possible use case, but i can see timers being handy in these bots.

and lets face it, the timer api in python is rather 'bleh' compared to a decorator like this.

Add an 8ball command to "rand"

missing bot.py file

Is this still supported? I think the bot.py file is missing in /bot

Add documentation for basic command API

Search of words in github issues from irc

Installation problems

Hey
I Copied the znc-bot folder to the ~/znc*/modules/ folder just as you said, but i get this error message when i am trying to load the module "Unable to find modinfo [bot] [Unable to find module [bot]]".
what should i do?

Upgrade github to use APIv3

Create a RSS plugin

Add a users system

This includes permissions so commands require certain privileges

votekick module