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.1.tar.gz (165.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.7.1-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.7.1.tar.gz
  • Upload date:
  • Size: 165.2 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.1.tar.gz
Algorithm Hash digest
SHA256 c5f9c23eb20c00c03cdd6f6c3b014270833a58dffe89daf9d05d1bcfdac95633
MD5 cd53a266e6fc6f12ac3da679187d4cc6
BLAKE2b-256 05f955d5e98a488cf42063455afbd0aea46aaf40f1928dd445340af55eb8d7b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kryten_moderator-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 513b7c1ffa61e1889c69f9a5b43518f1c4567cd097aeff16ddd1a55755934b99
MD5 7b48a3f2e4232f5c9d786741dd884845
BLAKE2b-256 1507e005b9893bc10368ef22abf0891995b6281837a3d76776ce5b069748c7c6

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