The aioxmpp package

The API reference provides the reference documentation of the public and private APIs of aioxmpp. Everything which is not in the Internal tools section is considered public API and subject to the API stability statement.

• On API stability and versioning
  • Requiring PEP 492
  • Semantic versioning and version numbers
  • Up to version 1.0.0
  • From version 1.0.0 onwards
• Version information
• Overview of Services
• Shorthands
• Main classes
  • node — XMPP network nodes (clients, mostly)
  • stream — Stanza stream
  • stanza — XSOs for dealing with stanzas
  • security_layer — Implementations to negotiate stream security
• Protocol part and XEP implementations
  • adhoc — Ad-Hoc Commands support (XEP-0050)
  • avatar — User avatar support (XEP-0084)
  • blocking — Blocking Command support (XEP-0191)
  • bookmarks – Bookmark support (XEP-0048)
  • carbons – Message Carbons (XEP-0280)
  • disco — Service discovery support (XEP-0030)
  • entitycaps — Entity Capabilities support (XEP-0390, XEP-0115)
  • forms — Data Forms support (XEP-0004)
  • hashes — Hash Functions for use with XMPP (XEP-0300)
  • im — Instant Messaging Utilities and Services
  • muc — Multi-User-Chat support (XEP-0045)
  • ping — XMPP Ping (XEP-0199)
  • presence — Peer presence bookkeeping
  • pep — PEP support (XEP-0163)
  • private_xml – Private XML Storage support (XEP-0049)
  • pubsub — Publish-Subscribe support (XEP-0060)
  • roster — RFC 6121 roster implementation
  • rfc6120 – Stanza payloads for RFC 6120 implementation
  • rfc3921 — XSOs for legacy protocol parts
  • rsm – Result Set Management (XEP-0059)
  • shim — Stanza Headers and Internet Metadata (XEP-0131)
• Less common and helper classes
  • structs — Simple data holders for common data types
  • tracking — Interfaces for high-level message tracking
  • nonza — Non-stanza stream-level XSOs (Nonzas)
  • sasl – SASL helpers
  • errors — Exception classes
  • i18n – Helper functions for localizing text
  • callbacks – Synchronous and asynchronous callbacks
  • connector — Ways to establish XML streams
  • dispatcher — Dispatch stanzas to callbacks
  • misc – Miscellaneous XSOs
• APIs mainly relevant for extension developers
  • service — Utilities for implementing Client services
  • xso — Working with XML stream contents
• Internal tools
  • cache — Utilities for implementing caches
  • e2etest — Framework for writing integration tests for aioxmpp
  • network — DNS resolution utilities
  • protocol — XML Stream implementation
  • statemachine – Utils for implementing a state machine
  • tasks – Manage herds of running coroutines
  • xml — XML utilities and interfaces for handling XMPP XML streams
• Changelog
  • Version 0.9
  • Version 0.8
  • Version 0.7
  • Version 0.6
  • Version 0.5
  • Version 0.4
  • Version 0.3