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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.3.3.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.11 Windows/11

File hashes

Hashes for kryten_moderator-0.3.3.tar.gz
Algorithm Hash digest
SHA256 93cbff2f475411661dd8c8656148104f9947a1efa0bf7d70953123aa106923f7
MD5 50d0e3954fe0e2d159db58842da1f9a7
BLAKE2b-256 dd8ff5516891cf3a7e915ee1ee0c91f9a567cb6e47270c59c38392e30ca0650a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kryten_moderator-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 25.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.11 Windows/11

File hashes

Hashes for kryten_moderator-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed59435cad571cb477e0e19e5647cd0c04869ec38abe80255f9491ca4d9058d5
MD5 ed5c8a0a22a816b1c47a871ab25afeb9
BLAKE2b-256 a1079dbb094a73beb1673acc6509aaf516912d1b6eb56c5e212db1344e493f91

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