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.3.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.3-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.7.3.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.3.tar.gz
Algorithm Hash digest
SHA256 8e06f032a4bc9363c97f1006893f41cdbdb9eb4a8215f9d56418f024659fab55
MD5 252656d917c3fb0c305fd097f777878f
BLAKE2b-256 45550be39c507a16b7a3b246c228f1b28ede47c4e002ff788b7e06930163efa0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kryten_moderator-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 56c3eb9ddd6dbffd1fb17585c656c270ff3294a866dbd6f135a50425e28048cf
MD5 fa46a5a1b3d67a9fa3ed64d3dc9dd461
BLAKE2b-256 e306e4a0b6c37726999768ae6cd928ef197c7e7fea69706ffac88e0ba1ed38bd

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