Skip to main content

XMPP bridging framework

Project description

Slidge 🛷

Home | Source | Issues | Patches | Chat

Turn any XMPP client into that fancy multiprotocol chat app that every cool kid want.

Documentation status builds.sr.ht status pypi

Slidge is a general purpose XMPP (puppeteer) gateway framework in python. It's a work in progress, but it should make writing gateways to other chat networks (plugins) as frictionless as possible.

It comes with a few plugins included.

Presences Typing Marks Upload Correction Reactions
Signal N/A N/A
Telegram ~
Mattermost
Facebook
Skype ~

(this table may not be entirely accurate, but in theory, stuff marked ✓ works)

Status

Slidge is alpha-grade software. Right now, only direct messages are implemented, no group chat stuff at all. Direct messaging does (more or less) work though. Any contribution whatsoever (testing, patches, suggestions, beer, …) is more than welcome. Don't be shy!

Testing locally should be fairly easy, so please go ahead and give me some feedback, through the MUC, the issue tracker or in my public inbox.

Installation

docker-compose

Docker-compose spins up a local XMPP server preconfigured for you., with a test@localhost / password account

docker-compose up # or poetry install && poetry run `python -m slidge`

For the other options, you need a configured XMPP server.

poetry

poetry install
poetry run python -m slidge

pip

pip install slidge[signal]  # you can replace signal with any network listed in the table above
python -m slidge --legacy-module=slidge.plugins.signal

XMPP client

movim

If you used docker-compose, you should be able to use the movim client from your browser at http://localhost:8888

Unfortunately, the movim UI thinks thattest@localhost is not a valid JID and does not let you click on the "Connect" button. As a workaround, use your browser dev tools to inspect and modify the <input id="username" in order to remove the pattern="^[^... attribute.

Then go to the Configuration/Account tab. You should be able to register to the slidge gateways from here.

Gajim

Install and launch gajim and add your XMPP account. Go to "Accounts"→"Discover services" (or equivalent). You should see the slidge gateways as server components.

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

Project details


Download files

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

Source Distribution

slidge-0.1.0a2.tar.gz (77.0 kB view details)

Uploaded Source

Built Distribution

slidge-0.1.0a2-py3-none-any.whl (97.7 kB view details)

Uploaded Python 3

File details

Details for the file slidge-0.1.0a2.tar.gz.

File metadata

  • Download URL: slidge-0.1.0a2.tar.gz
  • Upload date:
  • Size: 77.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.5 Linux/5.15.59-0-lts

File hashes

Hashes for slidge-0.1.0a2.tar.gz
Algorithm Hash digest
SHA256 23522e6b14cc6d450f635079f4e1be7ee845a1ce6259bc6128d3f3d0494b3b60
MD5 2745a590356733fb9cc424907f6c157d
BLAKE2b-256 e353a3227b48e0d7577545e6e40951734e1a6e78a7c7ab87e44505d526d4a55f

See more details on using hashes here.

File details

Details for the file slidge-0.1.0a2-py3-none-any.whl.

File metadata

  • Download URL: slidge-0.1.0a2-py3-none-any.whl
  • Upload date:
  • Size: 97.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.5 Linux/5.15.59-0-lts

File hashes

Hashes for slidge-0.1.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 5368647ab697643ba38cdff0cad4487dc096849c73af751a08d9b8dbc18542a5
MD5 9a312c933e5b3a4839251f1e114816d5
BLAKE2b-256 35af134a29bc9d7b2d442efdbe089a0701f1b67210284f654adbb4e0a9085866

See more details on using hashes here.

Supported by

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