Welcome to aioxmpp’s documentation!

Welcome to the documentation of aioxmpp! In case you do not know, aioxmpp is a pure-python XMPP library written for use with asyncio.

If you are new to aioxmpp, you should check out the Quick start, or read on below for an overview of the Features of aioxmpp. If you want to check the API reference to look something up, you should head to The aioxmpp package.

Contents:

• User guide
  • Installation
  • Quick start
• The aioxmpp package
  • On API stability and versioning
  • Version information
  • Shorthands
  • Main classes
  • Protocol part and XEP implementations
  • Less common and helper classes
  • APIs mainly relevant for extension developers
  • Internal tools
  • Changelog

Features

• Native XEP-0198 (Stream Management) support for robustness against transient network failures (such as switching between wireless and wired networks).
• Support for RFC 6121 (Instant Messaging and Presence, aioxmpp.presence, aioxmpp.roster) roster and presence management, along with XEP-0045 (Multi-User Chats, aioxmpp.muc) for your human-to-human needs.
• Support for XEP-0060 (Publish-Subscribe, aioxmpp.pubsub) as well as powerful declarative-style definition of your own protocols (aioxmpp.xso, aioxmpp.service) for your machine-to-machine needs.
• Several other XEPs, such as XEP-0115 (Entity Capabilities, aioxmpp.entitycaps, including native support for reading and writing the capsdb) and XEP-0131 (Stanza Headers and Internet Metadata, aioxmpp.shim).
• APIs suitable for both one-shot scripts and long-running multi-account clients.
• Secure by default: TLS is required by default, as well as certificate validation. Certificate or public key pinning can be used, if needed.
• Well-tested and modular codebase.

Check out the Quick start to get started with aioxmpp now! ☺

Dependencies

• Python ≥ 3.4 (or Python = 3.3 with tulip and enum34)

• DNSPython

• libxml2-devel (for some XML helpers)

• lxml

• orderedset

  (Note that ordered_set does not work!)

• tzlocal (for i18n support)

• pyOpenSSL

• pyasn1 and pyasn1_modules

• aiosasl

• multidict

• aioopenssl (optional, for now)

Contributing

The contribution guidelines are outlined in the README in the source code repository. The repository is hosted at GitHub.

Security Issues

If you believe that a bug you found in aioxmpp has security implications, you are welcome to notify me privately. To do so, send a mail to Jonas Wielicki, encrypted using the GPG public key:

0xE5EDE5AC679E300F
Fingerprint AA5A 78FF 508D 8CF4 F355  F682 E5ED E5AC 679E 300F

If you prefer to disclose security issues immediately, you can do so at any of the places listed in the contribution guidelines (see above).

Indices and tables

• Index
• Module Index
• Search Page