https://github.com/wlonk/quinoa

A Python framework for a MUC-aware XMPP bot.
https://github.com/wlonk/quinoa

Last synced: 14 days ago
JSON representation

A Python framework for a MUC-aware XMPP bot.

• Host: GitHub
• URL: https://github.com/wlonk/quinoa
• Owner: wlonk
• Created: 2011-11-20T20:51:32.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2014-07-23T05:39:02.000Z (over 10 years ago)
• Last Synced: 2024-04-09T21:15:49.899Z (7 months ago)
• Language: Python
• Homepage:
• Size: 230 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Quinoa

======

This is a simple class for creating Jabber bots capable of joining and

participating in MUC or groupchat.  It depends on xmpppy.

The name was chosen based on the simple fact that I like the grain quinoa, and

I like words starting with Q.

Requirements

============

This package depends on xmpppy.  It also requires a Jabber account if you wish

to actually use a bot.  To set up a useful bot, you will also need to set the

script to run as a daemon somewhere.  All of that is outside the scope of this

package.

Usage

=====

To make a bot, define a subclass of quinoa.Bot.  On this subclass, define

methods to perform the actions you desire.  Any return value of these methods

which does not evaluate to False will be returned as text to the room or person

the bot received the initiating message from.

Further, you must implement a method called register_commands on the subclass,

which will assign the methods defined above to keys in self.commands, a

regex-keyed dictionary.  Bear with me, it's going to get gross for a little

while.  This dictionary subclass takes strings as keys, but interprets them as

regexes.  When an item is retrieved from the dictionary, any string which

matches the regex defined when setting an item will work.  This allows one to

easily define bot commands as regexes, allowing a range of commands to map to

the same method.

Beyond register_commands, there are two optional methods, periodic_action and

on_connect which you can implement.  The first, periodic_action, defines a

method to be called every 10 seconds by the bot, and can be used to handle

items on a to-do queue, for example.  The second, on_connect, defines commands

to be run right after connecting to the server and before entering the

mainloop.  This can be used to set rooms to auto-join at startup, for example.

Examples

========

See quinoa.dicebot for an example of the code in action; it's a bot that rolls

dice for many different roleplaying systems, and responds to some stupid

meme-things.

Contact and Comments

====================

Please email me with suggestions or questions!  My email can be found on the

PyPI page for this project.