feat: introduce CI/CD workflow and packaging setup

Added Forgejo Actions workflow for Python package CI/CD, enabling automated testing and deployment to PyPI upon new tags. Introduced README and LICENSE files to document and license the project. Set up project with pyproject.toml, specifying dependencies, build system, and scripts. Configured .gitignore to exclude build artifacts.

Helps automate deployment and set a structured foundation for the project.

2024-08-17 15:36:04 +02:00

2.1 KiB

Raw Blame History

Matrix-Roomba

Roomba is a moderation bot for Matrix, designed to help manage rooms and enforce content policies. The bot can block/unblock rooms, shut down rooms, and notify users of shutdowns. It integrates with Synapse's administrative API and supports optional encryption through Pantalaimon.

Installation

pip install matrix-roomba

Create a configuration file in config.yaml based on the config.dist.yaml provided in the repository.

At the very least, you need to provide the following configuration:

homeserver: "https://matrix.example.com"
user_id: "@roomba:example.com"
access_token: "YOUR_ACCESS_TOKEN"
moderation_room_id: "!moderation_room_id:example.com"

Ensure that the bot user is an admin on the homeserver, as it needs to be able to moderate rooms. Also add the user to the moderation room before starting the bot.

We recommend using pantalaimon as a proxy, because the bot itself does not support end-to-end encryption.

You can start the bot by running:

Usage

Start the bot:

roomba

Send a message to the moderation room to get a list of available commands:

!roomba

Commands

In the moderation room, send commands to manage rooms:

Block a room: !roomba block <room_id>
Unblock a room: !roomba unblock <room_id>
Shutdown a room: !roomba shutdown <room_id> [--purge]
For help: !roomba

License

This project is licensed under the MIT License - see the LICENSE file for details.