almabtrieb 0.2.5

A library for the cattle drive protocol

almabtrieb

• Documentation
• Repository

This is a client library for the CattleDrive protocol as used by cattle_grid. This protocol is still somewhat in development.

This library enables one to create applications using cattle_grid as a middle ware to connect to the Fediverse. Examples:

• cattle_grid_rss, see also the deployed version at rss.bovine.social.
• roboherd

Supported protocols

Currently, supported are connection strings starting with amqp, amqps, mqtt, mqtts, ws, and wss.

• MQTT 5
• AMQP, I think 0.9.1 as supported by RabbitMQ

Authentication is relegated to the underlying protocol.

Development

Run tests with

uv run pytest

This will lead to a lot of skipped tests. By running

uv sync --all-extras

you can install the amqp and mqtt libraries and thus run more tests. For the tests against an actual connection, see the next subsection.

Running tests against a running cattle_grid instance

Create an account on cattle_grid with

python -mcattle_grid account new almabtrieb password --admin

Then with cattle grid running one can run

CONNECTION_STRING=mqtt://almabtrieb:password@localhost:11883 \
    uv run pytest almabtrieb/test_real.py
CONNECTION_STRING=ws://almabtrieb:password@localhost:15675/ws \
    uv run pytest almabtrieb/test_real.py
CONNECTION_STRING="amqp://almabtrieb:password@localhost:5672/" \
    uv run pytest almabtrieb/test_real.py