README

   1 SleekXMPP is an XMPP library written for Python 3.1+ (with 2.6 compatibility).
   2 Hosted at http://wiki.github.com/fritzy/SleekXMPP/
   3
   4 Featured in examples in XMPP: The Definitive Guide by Kevin Smith, Remko Tronçon, and Peter Saint-Andre
   5 If you're coming here from The Definitive Guide, please read http://wiki.github.com/fritzy/SleekXMPP/xmpp-the-definitive-guide
   6
   7 Requirements:
   8 We try to keep requirements to a minimum, but we suggest that you install http://dnspython.org although it isn't strictly required.
   9 If you do not install this library, you may need to specify the server/port for services that use SRV records (like GTalk).
  10 "sudo pip install dnspython" on a *nix system with pip installed.
  11
  12 SleekXMPP has several design goals/philosophies:
  13 - Low number of dependencies.
  14 - Every XEP as a plugin.
  15 - Rewarding to work with.
  16
  17 The goals for 1.0 include (and we're getting close):
  18 - Nearly Full test coverage of stanzas.
  19 - Wide range of functional tests.
  20 - Stanza objects for all interaction with the stream
  21 - Documentation on using and extending SleekXMPP.
  22 - Complete documentation on all implemented stanza objects
  23 - Documentation on all examples used in XMPP: The Definitive Guide
  24
  25 1.1 will include:
  26 - More functional and unit tests
  27 - PEP-8 compliance
  28 - XEP-225 support
  29
  30 Since 0.2, here's the Changelog:
  31 - MANY bugfixes
  32 - Re-implementation of handlers/threading to greatly simplify and remove bugs (no more spawning threads in handlers)
  33 - Stanza objects for jabber:client and all implemented XEPs
  34 - Raising XMPPError for jabber:client and extended errors in handlers
  35 - Robust error handling and better insurance of iq responses
  36 - Stanza objects have made life a lot easier!
  37 - Massive audit/cleanup.
  38
  39 Credits
  40 ----------------
  41 Main Author: Nathan Fritz fritz@netflint.net
  42 Contributors: Kevin Smith & Lance Stout
  43 Patches: Remko Tronçon
  44
  45 Dave Cridland, for his Suelta SASL library.
  46
  47
  48 Feel free to add fritzy@netflint.net to your roster for direct support and comments.
  49 Join sleekxmpp-discussion@googlegroups.com / http://groups.google.com/group/sleekxmpp-discussion for email discussion.
  50 Join sleek@conference.jabber.org for groupchat discussion.