Metadata-Version: 2.1
Name: slidge
Version: 0.0.0.dev0
Summary: XMPP bridging framework
Home-page: https://sr.ht/~nicoco/slidge/
License: AGPL-3.0-or-later
Author: Nicolas Cedilnik
Author-email: nicoco@nicoco.fr
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: ConfigArgParse (>=1.5.3,<2.0.0)
Requires-Dist: Pillow (>=10,<11)
Requires-Dist: aiohttp[speedups] (>=3.8.3,<4.0.0)
Requires-Dist: blurhash-python (>=1.2.1,<2.0.0)
Requires-Dist: pickle-secure (>=0.99.9,<0.100.0)
Requires-Dist: python-magic (>=0.4.27,<0.5.0)
Requires-Dist: qrcode (>=7.4.1,<8.0.0)
Requires-Dist: slixmpp (>=1.8.5,<2.0.0)
Description-Content-Type: text/markdown

![Slidge logo](./dev/assets/slidge-color-small.png)

[Home](https://sr.ht/~nicoco/slidge) |
[Docs](https://slidge.im/core) |
[Source](https://sr.ht/~nicoco/slidge/sources) |
[Issues](https://sr.ht/~nicoco/slidge/trackers) |
[Patches](https://lists.sr.ht/~nicoco/public-inbox) |
[Chat](xmpp:slidge@conference.nicoco.fr?join)

[![builds.sr.ht status](https://builds.sr.ht/~nicoco/slidge/commits/master/ci.yml.svg)](https://builds.sr.ht/~nicoco/slidge/commits/master/ci.yml?)
[![coverage](https://slidge.im/coverage.svg)](https://slidge.im/coverage)
[![pypi](https://badge.fury.io/py/slidge.svg)](https://pypi.org/project/slidge/)

Slidge is an XMPP (puppeteer) gateway library in python.
It makes
[writing gateways to other chat networks](https://slidge.im/core/dev/tutorial.html)
(*legacy modules*) as frictionless as possible.
It supports fancy IM features, such as
[(emoji) reactions](https://xmpp.org/extensions/xep-0444.html),
[replies](https://xmpp.org/extensions/xep-0461.html), and
[retractions](https://xmpp.org/extensions/xep-0424.html).
The full list of supported XEPs in on [xmpp.org](https://xmpp.org/software/slidge/).

Slidge is meant for gateway developers, if you are an XMPP server admin and
want to install gateways on your server, you are looking for one of these projects:

- [slidgnal](https://git.sr.ht/~nicoco/slidgnal) ([Signal](https://signal.org))
- [slidge-whatsapp](https://git.sr.ht/~nicoco/slidge-whatsapp) ([Whatsapp](https://whatsapp.com))
- [slidgram](https://git.sr.ht/~nicoco/slidgram) ([Telegram](https://telegram.org))
- [slidcord](https://git.sr.ht/~nicoco/slidcord) ([Discord](https://discord.com))
- [matteridge](https://git.sr.ht/~nicoco/matteridge) ([Mattermost](https://mattermost.com))
- [sleamdge](https://git.sr.ht/~nicoco/sleamdge) ([Steam](https://steamcommunity.com/))
- [skidge](https://git.sr.ht/~nicoco/skidge) ([Skype](https://skype.com/))
- [messlidger](https://git.sr.ht/~nicoco/messlidger) ([Facebook Messenger](https://messenger.com/))
- [matridge](https://git.sr.ht/~nicoco/matridge) ([Matrix](https://matrix.org/))

If you use debian, you might also be interested in the
[slidge-debian](https://git.sr.ht/~nicoco/slidge-debian)
bundle.

Status
------

Slidge is **beta**-grade software for 1:1 chats.
Group chat support is **experimental**.

Try slidge and give us some
feedback, through the [MUC](xmpp:slidge@conference.nicoco.fr?join), the
[issue tracker](https://todo.sr.ht/~nicoco/slidge) or in the
[public inbox](https://lists.sr.ht/~nicoco/public-inbox).
Don't be shy!

Installation
------------

Slidge is available on
[docker.io](https://hub.docker.com/u/nicocool84),
[pypi](https://pypi.org/project/slidge/) and as
[debian packages](https://slidge.im/core/admin/install.html#debian).
Refer to [the docs](https://slidge.im/core/admin/install.html) 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](https://www.spectrum.im/)
-   [telegabber](https://dev.narayana.im/narayana/telegabber)
-   [biboumi](https://biboumi.louiz.org/)
-   [Bifröst](https://github.com/matrix-org/matrix-bifrost)
-   [Mautrix](https://github.com/mautrix)
-   [matterbridge](https://github.com/42wim/matterbridge)

Thank you, [Trung](https://trung.fun/), for the slidge logo!

