Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added README

  • Loading branch information...
commit a2a65530a9ef2ceef4001e466853dbf437dca625 1 parent 7ec7472
@davidmarek authored
Showing with 39 additions and 0 deletions.
  1. +39 −0 README
View
39 README
@@ -0,0 +1,39 @@
+Jabber-Bot is pluginable lightweight python jabber bot. Every command the bot
+can process has to be written as plugin. Writing plugin is easy and everyone who
+knows python can write his own in few minutes.
+
+Jabber-Bot comes with few plugins. They are mainly for czech users.
+Plugins:
+ * FML - messages from http://fmylife.com
+ * MDT - messages from http://mydrunktexts.com
+ * IDOS(czech) - search connections in public transport system
+ * MHD(czech) - search connections in public transport system in cities
+ * Weather(czech) - weather information
+
+Write your own plugin! You just have to write one module file and place it in
+plugins directory. Here is template:
+
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+class MyPlugin:
+ """Write help for your plugin here"""
+
+ def __init__(self):
+ # Write initialization code here
+ pass
+
+ def run(self, contact, msg):
+ # Important attributes of contact: contact.get_jid() and contact.send(msg)
+ # msg is what user sent you without plugin name
+ # Write main logic of your plugin here
+ pass
+
+ def exit(self):
+ # Write clean up code
+ pass
+
+provides = {'plugin command' : MyPlugin}
+
+
+
Please sign in to comment.
Something went wrong with that request. Please try again.