__init__.py 1.7 KB

12345678910111213141516171819202122232425262728293031
  1. # $Id$
  2. """
  3. All features of xmpppy library contained within separate modules.
  4. At present there are modules:
  5. simplexml - XML handling routines
  6. protocol - XMPP-objects (I.e. JID and different stanzas and sub-stanzas) handling routines.
  7. debug - Jacob Lundquist's debugging module. Very handy if you like colored debug.
  8. auth - Non-SASL and SASL stuff. You will need it to auth as a client or transport.
  9. transports - low level connection handling. TCP and TLS currently. HTTP support planned.
  10. roster - simple roster for use in clients.
  11. dispatcher - decision-making logic. Handles all hooks. The first who takes control over fresh stanzas.
  12. features - different stuff that didn't worths separating into modules
  13. browser - DISCO server framework. Allows to build dynamic disco tree.
  14. filetransfer - Currently contains only IBB stuff. Can be used for bot-to-bot transfers.
  15. Most of the classes that is defined in all these modules is an ancestors of
  16. class PlugIn so they share a single set of methods allowing you to compile
  17. a featured XMPP client. For every instance of PlugIn class the 'owner' is the class
  18. in what the plug was plugged. While plugging in such instance usually sets some
  19. methods of owner to it's own ones for easy access. All session specific info stored
  20. either in instance of PlugIn or in owner's instance. This is considered unhandy
  21. and there are plans to port 'Session' class from xmppd.py project for storing all
  22. session-related info. Though if you are not accessing instances variables directly
  23. and use only methods for access all values you should not have any problems.
  24. """
  25. from . import simplexml,protocol,debug,auth,transports,roster,dispatcher,features,browser,filetransfer,commands
  26. from .client import *
  27. from .protocol import *