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.7.5.tar.gz (168.5 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.7.5-py3-none-any.whl (30.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.7.5.tar.gz
  • Upload date:
  • Size: 168.5 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.7.5.tar.gz
Algorithm Hash digest
SHA256 713b90a30d28e6892c25d23b9091090b8c696b689d0e5bf47f87deefffa037a1
MD5 5504a7cb57d630054f2d459adb43416e
BLAKE2b-256 1e798ff04102e0b691cb757a6dabc646ec1df680fd89dc3ed6d6dca636d3e0cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kryten_moderator-0.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 db8781a798fb2507b248a333b340f06957b2734e820193739841d7e4c1357a03
MD5 f937409564b4e3c719ed61d22ccd1293
BLAKE2b-256 93ee0cf541c483dd9e33ad76faa538ca35cd65291dfef84875522832b37e0730

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