Skip to main content

Slidge logo

woodpecker CI status coverage Chat

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 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 Gateway(BaseGateway[Session]):
    # 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 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.

pypi version

Packaging status

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

Thank you, Trung, for the slidge logo!

Metadata

Release files for slidge 0.5.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for slidge 0.5.4
File Size Uploaded Provenance Actions
slidge-0.5.4.tar.gz 566.2 kB Without provenance Details for slidge-0.5.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for slidge 0.5.4
File Interpreter ABI Platform Actions
slidge-0.5.4-py3-none-any.whl Python 3 none any Details for slidge-0.5.4-py3-none-any.whl

Total release size: 810.8 kB

Release files / slidge-0.5.4.tar.gz

Download URL slidge-0.5.4.tar.gz
Size 566.2 kB
Tags Source
SHA-256 checksum
How to use checksums
8c71135625a1822d5c9cc1544e54ad1b66b94f42c34cd02353bcf2cb63a18ef5
BLAKE2b-256 checksum
How to use checksums
e23afe3f81f365f2bdc6aeb1c72509e4adbf63809652dacc40941f1e230c1afe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / slidge-0.5.4-py3-none-any.whl

Download URL slidge-0.5.4-py3-none-any.whl
Size 244.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c77cb201081b58b613d59abb973d4779218e82e875a9354423d3ca16b3a21d81
BLAKE2b-256 checksum
How to use checksums
c288dd253348e4dfb909d08a0cba88a46775b349bc00c7717d0343b54e27482f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for slidge 0.5.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.5.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page