python-jabberbot

python-jabberbot application is a Jabber bot framework for Python that makes it easy to write simple Jabber bots. One can use these Jabber bots to provide information about running systems, to make Web sites interact with Jabber-enabled visitors, or notify the bot owner about updates or changes that are monitored with custom Python scripts.

Programming your own Jabber bot can be fun and helpful. This is python-jabberbot, a Jabber bot framework for Python that enables you to easily write simple Jabber bots. You can use your Jabber bots to provide information about your running systems, to make your website interact with your visitors or notify you about updates or changes you monitor with your Python scripts.

This Jabber bot is partly inspired by the xmpppy example bot.py, but designed to be re-usable and to make it easy to write small Jabber bots that do one thing and do it well.

Usage:

� Import the class: from jabberbot import JabberBot
� Subclass the JabberBot class
� Add methods starting with bot_, these will be exported as commands (e.g. def bot_display_id( self, mess, args)); the methods should return the message sent back to the user as string (or None if the command gives no reply)
� Create an instance of your bot, supplying username and password
� Call the serve_forever() method of your instance
� You can call the send() method on your bot to send messages to specific users

Example code:

from jabberbot import JabberBot
import datetime

class SystemInfoJabberBot(JabberBot):
def bot_serverinfo( self, mess, args):
"""Displays information about the server"""
version = open('/proc/version').read().strip()
loadavg = open('/proc/loadavg').read().strip()

return '%snn%s' % ( version, loadavg, )

def bot_time( self, mess, args):
"""Displays current server time"""
return str(datetime.datetime.now())

def bot_rot13( self, mess, args):
"""Returns passed arguments rot13'ed"""
return args.encode('rot13')

def bot_whoami( self, mess, args):
"""Tells you your username"""
return mess.getFrom()

username = 'my-jabberid@jabberserver.org'
password = 'my-password'
bot = SystemInfoJabberBot(username,password)
bot.serve_forever()

What is new in this release:

• various bugfixes and minor feature enhancements

What is new in version 0.13:

• This version adds support for optionally receiving one's own messages in the JabberBot.
• This is helpful when trying to build a federated multicast JabberBot network.

What is new in version 0.11:

• Several bugs in the examples and in the main module have been fixed.
• Support for Jabber Multi-User-Chats (MUCs) has been added, with an accompanying example.

What is new in version 0.6:

• This release fixes a dependency check for xmpppy.

Requirements:

• Python
• Xmpppy