                Introduction to xmpppy.
                 http://xmpppy.sf.net/

    This project aims for providing easy scripting for xmpp-enabled
applications. ATM (May 2008) the project is in maintance mode, alsmost
no new code is added so you can consider it to be stable, especially as 
most of bugs were fixed over last years. If you miss some feature - you
can also check out sources of Gajim client that is based upon this library
but maintains it's own branch of it.
    Documentation exists in three formats. 
    - The first is the examples that I wrote to show xmpppy in action. This is
      two simple scripts - README.py and xsend.py.
    - The second is the html pages where I try to describe the idea of library
      and the ways the goals are achieved.
    - Third is the docstrings. I am currently using epydoc but other tools
      should work too (at least the pydoc works)

                Installation
If you are using Debian or Ubuntu you can simply run
apt-get install python-xmpp
and you will get the current stable release of xmpppy installed. After
installation you can do 'import xmpp'. In case there is newer version released
that is not included into your distro - you can always install it manually.
Here you have several options:
  - run 'python setup.py install' from xmpppy distribution as root.
    All should work nice.
  - if you don't like python installator - just copy xmpp directory into python's
    site-packages directory (this is what setup.py does).
  - If you have no intention to install library system-wide (or just don't
    have no enough permissions to do it) you can copy xmpp directory to 
    your application's directory. Example:
        myxmpptry/
            xmpp/
                ...xmpppy modules
            test.py

If you have any questions about xmpppy usage or found a bug or want
to share some ideas - you are welcome to xmpppy-devel maillist - see
http://lists.sourceforge.net/lists/listinfo/xmpppy-devel
for details of subscription.

2008.05.05                  Alexey Nezhdanov
