Metadata-Version: 2.1
Name: Matridge
Version: 0.0.0.dev0
Summary: 
Author: Nicoco
Author-email: nicoco@nicoco.fr
Requires-Python: >=3.9,<4.0
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: async-lru (>=2.0.3,<3.0.0)
Requires-Dist: beautifulsoup4 (>=4.12.2,<5.0.0)
Requires-Dist: matrix-nio[e2e] (>=0.24,<0.25)
Requires-Dist: slidge @ git+https://git.sr.ht/~nicoco/slidge@master
Requires-Dist: slidge-style-parser (>=0.1.6,<0.2.0)
Description-Content-Type: text/markdown

# matridge

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

A
[feature-rich](https://slidge.im/matridge/features.html)
[Matrix](https://matrix.org) to
[XMPP](https://xmpp.org/) puppeteering
[gateway](https://xmpp.org/extensions/xep-0100.html), based on
[slidge](https://slidge.im) and
[nio](https://matrix-nio.readthedocs.io/).

[![builds.sr.ht status](https://builds.sr.ht/~nicoco/matridge/commits/master/ci.yml.svg)](https://builds.sr.ht/~nicoco/matridge/commits/master/ci.yml)
[![containers status](https://builds.sr.ht/~nicoco/matridge/commits/master/container.yml.svg)](https://builds.sr.ht/~nicoco/matridge/commits/master/container.yml)
[![pypi status](https://badge.fury.io/py/matridge.svg)](https://pypi.org/project/matridge/)

## Installation

Refer to the [slidge admin documentation](https://slidge.im/core/admin/)
for general info on how to set up an XMPP server component.

### Containers

From [dockerhub](https://hub.docker.com/r/nicocool84/matridge)

```sh
docker run docker.io/nicocool84/matridge
```

### Python package

With [pipx](https://pypa.github.io/pipx/):

```sh

# for the latest stable release (if any)
pipx install matridge

# for the bleeding edge
pipx install matridge \
    --pip-args='--extra-index-url https://slidge.im/repo'

matridge --help
```

## Dev

```sh
git clone https://git.sr.ht/~nicoco/matridge
cd matridge
docker-compose up
```

