Skip to main content

Kryten moderation service - handles chat moderation and filtering

Project description

"# 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

  1. Install dependencies:
uv sync
  1. Copy the example configuration:
cp config.example.json config.json
  1. Edit config.json with 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 "

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kryten_moderator-0.8.0.tar.gz (175.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kryten_moderator-0.8.0-py3-none-any.whl (35.6 kB view details)

Uploaded Python 3

File details

Details for the file kryten_moderator-0.8.0.tar.gz.

File metadata

  • Download URL: kryten_moderator-0.8.0.tar.gz
  • Upload date:
  • Size: 175.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kryten_moderator-0.8.0.tar.gz
Algorithm Hash digest
SHA256 11f96dcbdf9630b19c8d1cc5bc3ba2f2397a20a7541398aef9ffea83f849b316
MD5 a597708ee43a07d169b199570afd0b34
BLAKE2b-256 cab48e7ac35cc1ee62b6bdae471363013c95b5dcf2988f55b4406867d383213f

See more details on using hashes here.

File details

Details for the file kryten_moderator-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kryten_moderator-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7c74c3a809bc9a801db712f0b8d1ce8c7279867a10eaecfee3a23abf1108e8b
MD5 a2cb464a3c4ad0624bb0627d204dea2c
BLAKE2b-256 9d08e48f5cc7e074dfe536faa16c236b2a95b5a7bb13a31fc98e82e1919eb57e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page