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.5.0.tar.gz (154.2 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.5.0-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.5.0.tar.gz
  • Upload date:
  • Size: 154.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.4

File hashes

Hashes for kryten_moderator-0.5.0.tar.gz
Algorithm Hash digest
SHA256 1c29bd38e048dda6dfa2cf349dd3b0e1deb7dae7be1b3959d972f324675dc892
MD5 8cdc0013d38e50f546b970c34e0e7e2f
BLAKE2b-256 697185bbae559457ad87c3251147bfe0b68c50323c056203d501e6a97a5d5d47

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kryten_moderator-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8fdd3c311090d0976a0c1e761373572b6a40ad00ce401fd4dc6837ab824725e5
MD5 a23b39bda0eff7f2dfeef576758db5db
BLAKE2b-256 bd74751e9b52069e49a9c7fa8d43c9732cb31502c54af347b3723ece16eded8b

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