Skip to main content
https://img.shields.io/pypi/v/pyjabber.svg Python 3.8 to 3.12 Build Status Coverage Status Code lines counter Documentation Status Monthly downloads Total downloads

PyJabber is an asyncio server for Jabber/XMPP entirely written in Python, with minimal reliance on external libraries.
It strives to provide a simple, lightweight, and comprehensible codebase, featuring a modular structure.
While initially designed to fulfill the requirements of the multi-agent system SPADE, it can be easily customized to suit any other purpose.

Installation

pip install pyjabber

Quick start

Python program

The process of starting the server returns a coroutine, leaving it to the user to set up the required environment. The simplest approach is to use the asyncio.run function.

from pyjabber.server import Server

my_server = Server()
asyncio.run(my_server.start())

This allows PyJabber to be treated as a regular task and integrated seamlessly into an asynchronous application.

import asyncio
from pyjabber.server import Server

async def counter():
  while True:
    await asyncio.sleep(1)
    print(f"Hello World")

async def launch():
  my_server = Server()
  await asyncio.gather(my_server.start(), counter())

asyncio.run(launch())

CLI

The CLI launcher is the fastest way to start using the server.

$ pyjabber
2024-12-18 09:03:22.880 - INFO: Starting server...
2024-12-18 09:03:22.881 - INFO: Client domain => localhost
2024-12-18 09:03:22.881 - INFO: Server is listening clients on [('127.0.0.1', 5222), ('158.42.155.44', 5222)]
2024-12-18 09:03:22.881 - INFO: Serving admin webpage on http://localhost:9090
2024-12-18 09:03:22.881 - INFO: Server is listening servers on [('0.0.0.0', 5269)]
2024-12-18 09:03:22.881 - INFO: Server started...

Features

Status

Description

TLS

Implemented

v1.3. Localhost certificate included

SASL

Implemented

PLAIN, EXTERNAL (s2s)

Roster

Implemented

CRUD avaliable

Presence

Implemented (local bound)

Subscribe, Unsubscribed, Initial presence and Unavailable

Plugins

Status

Description

XEP-0004

IMPLEMENTED

Dataforms

XEP-0030

IMPLEMENTED

Service Discovery

XEP-0060

IMPLEMENTED

Pubsub

XEP-0077

IMPLEMENTED

In Band Registration

XEP-0199

IMPLEMENTED

Ping

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyjabber-0.4.1.tar.gz (962.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyjabber-0.4.1-py3-none-any.whl (990.4 kB view details)

Uploaded Python 3

File details

Details for the file pyjabber-0.4.1.tar.gz.

File metadata

  • Download URL: pyjabber-0.4.1.tar.gz
  • Upload date:
  • Size: 962.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pyjabber-0.4.1.tar.gz
Algorithm Hash digest
SHA256 5b26c27f6b5fc8a13f0ace10bd5a48eb3055d50525cb0fb0a4b74132421001c5
MD5 381c26bd0008b6ecfdc0232357f6f7b3
BLAKE2b-256 70379481e2b7a9747646ff7ac50853a6c5e7fcde1d3bdddce3e39d2372de2693

See more details on using hashes here.

File details

Details for the file pyjabber-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: pyjabber-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 990.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pyjabber-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 75d3357698258279817ea81513f9b00783d1bdee58fa3d203148c7638cc6d2fe
MD5 1f698bdd7db0d277bdb3ece2f3de6d61
BLAKE2b-256 04014fe88a8b596fdbd403a567a5e6b44e3c352be959aa1e8c3ac140f32be762

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page