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.4.tar.gz (168.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.4-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.7.4.tar.gz
  • Upload date:
  • Size: 168.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.4.tar.gz
Algorithm Hash digest
SHA256 54ecac804c0612448ef87fa9c2d3753f19d129f6d0e37f1d8136726029cc5f7c
MD5 3716a054991360544a58d83df3dd1397
BLAKE2b-256 2ba729c093f66937c77947edf8f6a48432f58ef3e881eab67fa63f8dfca3a187

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kryten_moderator-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8424107cd3324d94519af4b5bfd884b77a2e89001d58b5464d307d3486b71cb5
MD5 91ac5e258228cd51d91f5bab8152b253
BLAKE2b-256 53d2c2f0115f356aacacf49e35ac458f16794a90de3444591c5b3141a7d158f5

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