slidge 0.4.0b1

XMPP bridging framework

Slidge is an XMPP (puppeteer) gateway library in python. It makes writing gateways to other chat networks (legacy modules) as frictionless as possible. It supports fancy IM features, such as (emoji) reactions, replies, and retractions. The full list of supported XEPs in on xmpp.org.

Status

Slidge is beta-grade software. It support groups and 1:1 chats. Try slidge and give us some feedback, through the MUC or the issue tracker. Don't be shy!

Usage

A minimal (and fictional!) slidge-powered "legacy module" looks like this:

from cool_chat_lib import CoolClient
from slidge import BaseGateway, BaseSession
from slidge.contact import LegacyContact
from slidge.group import LegacyMUC
from slidge.db import GatewayUser
from slidge.util.types import XMPPMessage


class Gateway(BaseGateway):
    # Various aspects of the gateway component are configured as class
    # attributes of the concrete Gateway class
    COMPONENT_NAME = "Gateway to the super duper chat network"


class Session(BaseSession):
    async def login(self, user: GatewayUser) -> None:
        self.legacy_client = CoolClient(
            login=user.legacy_module_data["username"],
            password=user.legacy_module_data["password"],
        )
        await self.legacy_client.login()


class Contact(LegacyContact):
    async def on_message(self, msg: XMPPMessage) -> str:
        """
        Triggered when the slidge user sends an XMPP message through the gateway
        """
        sent = self.session.legacy_client.send_message(text=text, destination=self.legacy_id)
        return str(sent.message_id)

There's more in the tutorial!

Installation

⚠️ Slidge is a lib for gateway developers, if you are an XMPP server admin and want to install gateways on your server, you are looking for a slidge-based gateway. or the slidge-debian bundle.

Slidge is available on codeberg and pypi. Refer to the docs for details.

About privacy

Slidge (and most if not all XMPP gateway that I know of) will break end-to-end encryption, or more precisely one of the 'ends' become the gateway itself. If privacy is a major concern for you, my advice would be to:

• use XMPP + OMEMO
• self-host your gateways
• have your gateways hosted by someone you know AFK and trust

Related projects

• Spectrum
• telegabber
• biboumi
• Bifröst
• Mautrix
• matterbridge

Thank you, Trung, for the slidge logo!