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.3.5.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.3.5-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kryten_moderator-0.3.5.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.3.5.tar.gz
Algorithm Hash digest
SHA256 c7ced6ffd09c2a61571b29873bf4015b5ead36230c2ecf774b7834080d176e1a
MD5 6a1646113b1c06f270f80ef72fd9c03f
BLAKE2b-256 9dace4b6818d7596cee4c4bbf2133c650fccc9171799a576c4c0c5f2e4be2677

See more details on using hashes here.

Provenance

The following attestation bundles were made for kryten_moderator-0.3.5.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.3.5-py3-none-any.whl.

File metadata

File hashes

Hashes for kryten_moderator-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ce47a11aae1c648538f0e43f921ffdacded59028e891df257d8ceef65b0e0ffc
MD5 580df919c3d1f43c956e827fd48dbde5
BLAKE2b-256 e6a401fe2d788f050256136511418d693535fa06c38c673ff4bafcbbc73b53b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for kryten_moderator-0.3.5-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