User guide

The user guide aims to provide a full step-by-step reference on using the library.

• Installation
  • Installing using your system’s package manager
  • Installing from PyPI
    • Installing dependencies using your system’s package manager (recommended)
    • Installing dependencies from PyPI
    • Installing aioxmpp
  • Installing in editable mode from source
    • Running the unittests
• Quick start
  • Preparations
  • Connect to an XMPP server, with JID and Password
  • Send a message
  • Change presence
  • React to messages (Echo Bot)
  • React to presences
  • React to IQ requests
  • Use services
  • Use aioxmpp.PresenceClient presence implementation
  • React to a XEP-0092 Software Version IQ request
  • Next steps
• Pitfalls to avoid
  • When my application exits uncleanly, it still appears to be online to other resources
  • I am trying to connect to a bare IP and I get a DNS error
• Frequently Asked Questions
  • Why yet another XMPP library for Python / asyncio?
  • Why does aioxmpp try to handle everything?
  • Shouldn’t X be up to the application?
• An Introduction to XSO
  • About aioxmpp.xso
    • What is aioxmpp.xso?
    • What is aioxmpp.xso not?
    • How much Magic is inside aioxmpp.xso?
  • Into the Deep End / Very Quick Start
  • A Bit of XSO Terminology
  • Writing XSO classes
    • XSO descriptors
      • Attribute Descriptors
      • Text Descriptors
      • Scalar Child Descriptors
      • Non-scalar Child Descriptors
    • Handling of unexpected attributes and child elements
    • Character Data Types
    • Combining the Above in an Example
  • Reference Documentation