========================================
About
========================================
This library supports an XMPP chat interface to the Exosite Data Platform.

License is BSD, Copyright 2010, Exosite LLC


========================================
Required Packages
========================================
****************************************
1) xmpppy
****************************************
http://xmpppy.sourceforge.net/
http://sourceforge.net/projects/xmpppy/
http://sourceforge.net/projects/xmpppy/files/xmpppy/0.4.0/xmpppy-0.4.0.win32.exe/download

If running Debian Linux (or Ubuntu), you can > apt-get install python-xmpp

****************************************
2) dnspython
****************************************
http://www.dnspython.org/

If running Debian Linux (or Ubuntu), you can > apt-get install python-dns
NOTE: this step is not always necessary, depends on xmpp server you use


========================================
Installation
========================================
1.) Unpack the distribution package

2.) Change into the source directory

3.) Install the package
	
	python setup.py install


========================================
Quick Start
========================================
To access XMPP Chat API commands, use:

	from exompp.xmmpchat import *

This library requires you to initialize it with a list that includes the 
following elements:
{'user_id':<user_id>, 'password':<password>, 'exosite_bot':<exosite_bot>}

	<user_id> = [Your xmpp account username, e.g. myxmppaccount@domain.com]
	<password> = [Your xmpp account password]
	<exosite_bot> = commander@m2.exosite.com

Please refer to Exosite documentation for complete details.

Feel free to extend the library as needed!


========================================
Release Info
========================================

Release 0.2
----------------------------------------
--) removed API version dependency
--) changed instantiation to use parameters instead of config file path
--) removed functions that didn't belong (getconfiguration and getsubscribers)
--) added stop function to kill buffering thread

Release 0.1
----------------------------------------
--) initial version