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.0.tar.gz (164.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.7.0-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.7.0.tar.gz
  • Upload date:
  • Size: 164.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.7.0.tar.gz
Algorithm Hash digest
SHA256 30d34d5bc9f2f2120d33359e548fa2b7768c27811c7a8b3fc408e43b8a72b430
MD5 0a2bf24f9bb3ac21de773bafa1304a02
BLAKE2b-256 62cb14fd27951fdbff3295b9143c1cae97204d78e383e7a51f4ff27d92356cde

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kryten_moderator-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e02830913f98b232d42d1995a7cb2c47df4e486537cbc5372782a04a6bde279c
MD5 7f75dc1f4d0aaee2d53195fee54a9cd5
BLAKE2b-256 63ca0de597793790000e4bca817d39c6f563111dbb89d3b90f4f30ba92411510

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