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.4.0.tar.gz (153.4 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.4.0-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.4.0.tar.gz
  • Upload date:
  • Size: 153.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kryten_moderator-0.4.0.tar.gz
Algorithm Hash digest
SHA256 5aee524f272083c7e560ac35d624b3f3d2c333edb97ea8d0d3ed8c30540df901
MD5 888702ff4d12e67b6a562df0623df17c
BLAKE2b-256 0767eb35a151d8e47d036e93a1ddd21b2102dbf999ca75ac13d6453dc0a21993

See more details on using hashes here.

Provenance

The following attestation bundles were made for kryten_moderator-0.4.0.tar.gz:

Publisher: python-publish.yml on grobertson/kryten-moderator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for kryten_moderator-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a512fd56ce63f0341e3988b6f40c093b94314debcc379bfca1e757df23fe0de7
MD5 8f57a1895ccb8db2999925cd118304aa
BLAKE2b-256 f92b4d5014278138260c0214d981746acc0379368ba1b27e2f95d18ba8f99111

See more details on using hashes here.

Provenance

The following attestation bundles were made for kryten_moderator-0.4.0-py3-none-any.whl:

Publisher: python-publish.yml on grobertson/kryten-moderator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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