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.6.tar.gz (169.0 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.6-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.7.6.tar.gz
  • Upload date:
  • Size: 169.0 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.6.tar.gz
Algorithm Hash digest
SHA256 59ad24fd9bb4c08cf261092fe7325b7c4c3bb6d5ed55dd6935438eb948fa7d87
MD5 216d83149016b90d9601c338333e5403
BLAKE2b-256 b267caca88083256f1e6193e85304dc64eae275612ae681dd57ce9bcb941d489

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kryten_moderator-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 edf24db0ab75704912293a6a4bf641a6381ce4658179c728d6d48bb0f320fca2
MD5 cf24a3eeacc447f99754d6a2344880c6
BLAKE2b-256 502678e1d7a1c9feae042abdc33f90bfe2a3fcea3fe83c495a7dafc509b2e8c7

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