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:
poetry install
  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:

poetry 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

poetry run pytest

Linting

poetry run ruff check .

Formatting

poetry 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.3.1.tar.gz (21.6 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.3.1-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.3.1.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for kryten_moderator-0.3.1.tar.gz
Algorithm Hash digest
SHA256 a8393f430131d73acb1815d9e5380933469290f339619518de8a45e0c248e0de
MD5 d7eabc0b7be97f49eef81efe8ed0d2cc
BLAKE2b-256 7723117fc0217b3510ffe3548e85a4bb5e7b8dca8e4da8f976332b9044e9dfd1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kryten_moderator-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1f39c2dd7693065f13ba3d7e9350215f332db5009a35ef928342b3ef79bde69c
MD5 20640c2f9d62c66f3dbf16f24c563b4d
BLAKE2b-256 ff0ce3d35512b1def7651d9d53f11353ff85cd3e417c17112db4189b3a1a8b22

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