"# Kryten Moderator
Kryten moderation service - handles chat moderation and filtering for CyTube.
Features
- Real-time chat message monitoring
- User tracking and management
- Event-driven architecture using NATS
- Extensible moderation rules
Installation
Prerequisites
- Python 3.10 or higher
- Poetry
- NATS server running
- kryten-py library
Setup
- Install dependencies:
uv sync
- Copy the example configuration:
cp config.example.json config.json
- Edit
config.jsonwith your settings:
{
"nats_url": "nats://localhost:4222",
"nats_subject_prefix": "kryten",
"service_name": "moderator"
}
Usage
Running the Service
Using Poetry:
uv run kryten-moderator --config config.json
Using the startup script (PowerShell):
.\start-moderator.ps1
Using the startup script (Bash):
./start-moderator.sh
Command Line Options
--config PATH: Path to configuration file (default:/etc/kryten/moderator/config.json)--log-level LEVEL: Set logging level (DEBUG, INFO, WARNING, ERROR)
Event Handling
The service currently listens for:
- chatMsg: Chat messages from users
- addUser: User join events
Development
Running Tests
uv run pytest
Linting
uv run ruff check .
Formatting
uv run black .
License
MIT License - see LICENSE file for details "
1 maintainer
Release files for kryten-moderator 0.8.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| kryten_moderator-0.8.1.tar.gz | 188.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kryten_moderator-0.8.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 224.6 kB
Release files / kryten_moderator-0.8.1.tar.gz
| Download URL | kryten_moderator-0.8.1.tar.gz |
|---|---|
| Size | 188.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
94b4dc4df76b5e434999b1b1da7f999981c65685419c07188041a011a58d6dc3
|
|
BLAKE2b-256 checksum How to use checksums |
9ed6d29552c51557873b68eb4b0256ed7afff24aa6265b9cd3589559489ee7eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / kryten_moderator-0.8.1-py3-none-any.whl
| Download URL | kryten_moderator-0.8.1-py3-none-any.whl |
|---|---|
| Size | 35.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1141c08a59660b2675b3f5ff2ab890b4b7e33b515753e4199ebd7a6703d832e0
|
|
BLAKE2b-256 checksum How to use checksums |
dbdc55896ff5e153cb115c277d6548cd54ba0e24c5453a4e09686df4f7a2418a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
