diff options
| -rw-r--r-- | README | 50 | ||||
| -rw-r--r-- | README.rst | 91 | ||||
| -rw-r--r-- | setup.py | 2 |
3 files changed, 92 insertions, 51 deletions
diff --git a/README b/README deleted file mode 100644 index 8a85365c..00000000 --- a/README +++ /dev/null @@ -1,50 +0,0 @@ -SleekXMPP is an XMPP library written for Python 3.1+ (with 2.6 compatibility). -Hosted at http://wiki.github.com/fritzy/SleekXMPP/ - -Featured in examples in XMPP: The Definitive Guide by Kevin Smith, Remko Tronçon, and Peter Saint-Andre -If you're coming here from The Definitive Guide, please read http://wiki.github.com/fritzy/SleekXMPP/xmpp-the-definitive-guide - -Requirements: -We try to keep requirements to a minimum, but we suggest that you install http://dnspython.org although it isn't strictly required. -If you do not install this library, you may need to specify the server/port for services that use SRV records (like GTalk). -"sudo pip install dnspython" on a *nix system with pip installed. - -SleekXMPP has several design goals/philosophies: -- Low number of dependencies. -- Every XEP as a plugin. -- Rewarding to work with. - -The goals for 1.0 include (and we're getting close): -- Nearly Full test coverage of stanzas. -- Wide range of functional tests. -- Stanza objects for all interaction with the stream -- Documentation on using and extending SleekXMPP. -- Complete documentation on all implemented stanza objects -- Documentation on all examples used in XMPP: The Definitive Guide - -1.1 will include: -- More functional and unit tests -- PEP-8 compliance -- XEP-225 support - -Since 0.2, here's the Changelog: -- MANY bugfixes -- Re-implementation of handlers/threading to greatly simplify and remove bugs (no more spawning threads in handlers) -- Stanza objects for jabber:client and all implemented XEPs -- Raising XMPPError for jabber:client and extended errors in handlers -- Robust error handling and better insurance of iq responses -- Stanza objects have made life a lot easier! -- Massive audit/cleanup. - -Credits ----------------- -Main Author: Nathan Fritz fritz@netflint.net -Contributors: Kevin Smith & Lance Stout -Patches: Remko Tronçon - -Dave Cridland, for his Suelta SASL library. - - -Feel free to add fritzy@netflint.net to your roster for direct support and comments. -Join sleekxmpp-discussion@googlegroups.com / http://groups.google.com/group/sleekxmpp-discussion for email discussion. -Join sleek@conference.jabber.org for groupchat discussion. diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..dc29b639 --- /dev/null +++ b/README.rst @@ -0,0 +1,91 @@ +SleekXMPP +######### + +SleekXMPP is an MIT licensed XMPP library for Python 2.6/3.1+, +and is featured in examples in +`XMPP: The Definitive Guide <http://oreilly.com/catalog/9780596521271>`_ +by Kevin Smith, Remko Tronçon, and Peter Saint-Andre. If you've arrived +here from reading the Definitive Guide, please see the notes on updating +the examples to the latest version of SleekXMPP. + +SleekXMPP's design goals and philosphy are: + +**Low number of dependencies** + Installing and using SleekXMPP should be as simple as possible, without + having to deal with long dependency chains. + + As part of reducing the number of dependencies, some third party + modules are included with SleekXMPP in the ``thirdparty`` directory. + Imports from this module first try to import an existing installed + version before loading the packaged version, when possible. + +**Every XEP as a plugin** + Following Python's "batteries included" approach, the goal is to + provide support for all currently active XEPs (final and draft). Since + adding XEP support is done through easy to create plugins, the hope is + to also provide a solid base for implementing and creating experimental + XEPs. + +**Rewarding to work with** + As much as possible, SleekXMPP should allow things to "just work" using + sensible defaults and appropriate abstractions. XML can be ugly to work + with, but it doesn't have to be that way. + + +Get the Code +------------ +.. code-block:: sh + + pip install sleekxmpp + +The latest source code for SleekXMPP may be found on `Github +<http://github.com/fritzy/SleekXMPP>`_. Releases can be found in the +``master`` branch, while the latest development version is in the +``develop`` branch. + +**Stable Releases** + - `1.0 Beta6.1 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta6.1>`_ + - `1.0 Beta5 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta5>`_ + - `1.0 Beta4 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta4>`_ + - `1.0 Beta3 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta3>`_ + - `1.0 Beta2 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta2>`_ + - `1.0 Beta1 <http://github.com/fritzy/SleekXMPP/zipball/1.0-Beta1>`_ + +**Develop Releases** + - `Latest Develop Version <http://github.com/fritzy/SleekXMPP/zipball/develop>`_ + + +Discussion +---------- +A mailing list and XMPP chat room are available for discussing and getting +help with SleekXMPP. + +**Mailing List** + `SleekXMPP Discussion on Google Groups <http://groups.google.com/group/sleekxmpp-discussion>`_ + +**Chat** + `sleek@conference.jabber.org <xmpp:sleek@conference.jabber.org?join>`_ + + +Credits +------- +**Main Author:** Nathan Fritz + `fritzy@netflint.net <xmpp:fritzy@netflint.net?message>`_, + `@fritzy <http://twitter.com/fritzy>`_ + + Nathan is also the author of XMPPHP and `Seesmic-AS3-XMPP + <http://code.google.com/p/seesmic-as3-xmpp/>`_, and a member of the XMPP + Council. + +**Co-Author:** Lance Stout + `lancestout@gmail.com <xmpp:lancestout@gmail.com?message>`_, + `@lancestout <http://twitter.com/lancestout>`_ + +**Contributors:** + - Brian Beggs (`macdiesel <http://github.com/macdiesel>`_) + - Dann Martens (`dannmartens <http://github.com/dannmartens>`_) + - Florent Le Coz (`louiz <http://github.com/louiz>`_) + - Kevin Smith (`Kev <http://github.com/Kev>`_, http://kismith.co.uk) + - Remko Tronçon (`remko <http://github.com/remko>`_, http://el-tramo.be) + - Te-jé Rogers (`te-je <http://github.com/te-je>`_) + - Thom Nichols (`tomstrummer <http://github.com/tomstrummer>`_) @@ -29,7 +29,7 @@ import sleekxmpp VERSION = sleekxmpp.__version__ DESCRIPTION = 'SleekXMPP is an elegant Python library for XMPP (aka Jabber, Google Talk, etc).' -with open('README') as readme: +with open('README.rst') as readme: LONG_DESCRIPTION = '\n'.join(readme) CLASSIFIERS = [ 'Intended Audience :: Developers', |