kryten-moderator 0.1.0__tar.gz

kryten_moderator-0.1.0/INSTALL.md

@@ -0,0 +1,212 @@
+# Installation Guide
+
+## Prerequisites
+
+- Python 3.10 or higher
+- Poetry (Python package manager)
+- NATS server (running and accessible)
+- Git
+
+## Quick Start
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/grobertson/kryten-moderator.git
+cd kryten-moderator
+```
+
+### 2. Install Dependencies
+
+```bash
+poetry install
+```
+
+### 3. Configure the Service
+
+Copy the example configuration:
+
+```bash
+cp config.example.json config.json
+```
+
+Edit `config.json` with your settings:
+
+```json
+{
+  "nats_url": "nats://localhost:4222",
+  "nats_subject_prefix": "cytube",
+  "service_name": "kryten-moderator"
+}
+```
+
+### 4. Run the Service
+
+**Development mode:**
+
+```bash
+poetry run kryten-moderator --config config.json --log-level DEBUG
+```
+
+**Using startup script (PowerShell):**
+
+```powershell
+.\start-moderator.ps1
+```
+
+**Using startup script (Bash):**
+
+```bash
+./start-moderator.sh
+```
+
+## Production Installation
+
+### System User Setup
+
+Create a dedicated system user:
+
+```bash
+sudo useradd -r -s /bin/false -d /opt/kryten-moderator kryten
+```
+
+### Installation Directory
+
+```bash
+sudo mkdir -p /opt/kryten-moderator
+sudo chown kryten:kryten /opt/kryten-moderator
+```
+
+### Configuration Directory
+
+```bash
+sudo mkdir -p /etc/kryten/moderator
+sudo chown kryten:kryten /etc/kryten/moderator
+sudo cp config.example.json /etc/kryten/moderator/config.json
+sudo chown kryten:kryten /etc/kryten/moderator/config.json
+sudo chmod 600 /etc/kryten/moderator/config.json
+```
+
+Edit the configuration:
+
+```bash
+sudo nano /etc/kryten/moderator/config.json
+```
+
+### Log Directory
+
+```bash
+sudo mkdir -p /var/log/kryten-moderator
+sudo chown kryten:kryten /var/log/kryten-moderator
+```
+
+### Install Application
+
+```bash
+cd /opt/kryten-moderator
+sudo -u kryten git clone https://github.com/grobertson/kryten-moderator.git .
+sudo -u kryten poetry install --no-dev
+```
+
+### Systemd Service
+
+Install the systemd service:
+
+```bash
+sudo cp systemd/kryten-moderator.service /etc/systemd/system/
+sudo systemctl daemon-reload
+sudo systemctl enable kryten-moderator
+sudo systemctl start kryten-moderator
+```
+
+Check service status:
+
+```bash
+sudo systemctl status kryten-moderator
+sudo journalctl -u kryten-moderator -f
+```
+
+## Updating
+
+### Development
+
+```bash
+git pull
+poetry install
+```
+
+### Production
+
+```bash
+cd /opt/kryten-moderator
+sudo systemctl stop kryten-moderator
+sudo -u kryten git pull
+sudo -u kryten poetry install --no-dev
+sudo systemctl start kryten-moderator
+```
+
+## Troubleshooting
+
+### Check NATS Connection
+
+Ensure NATS server is running:
+
+```bash
+# Check if NATS is listening
+netstat -tuln | grep 4222
+```
+
+### View Logs
+
+```bash
+# Systemd service logs
+sudo journalctl -u kryten-moderator -f
+
+# Check for errors
+sudo journalctl -u kryten-moderator --since "1 hour ago" | grep -i error
+```
+
+### Test Configuration
+
+```bash
+# Validate JSON syntax
+python -m json.tool config.json
+
+# Test connection manually
+poetry run kryten-moderator --config config.json --log-level DEBUG
+```
+
+### Permissions Issues
+
+Ensure correct ownership:
+
+```bash
+sudo chown -R kryten:kryten /opt/kryten-moderator
+sudo chown -R kryten:kryten /etc/kryten/moderator
+sudo chown -R kryten:kryten /var/log/kryten-moderator
+```
+
+## Uninstalling
+
+### Stop and Disable Service
+
+```bash
+sudo systemctl stop kryten-moderator
+sudo systemctl disable kryten-moderator
+sudo rm /etc/systemd/system/kryten-moderator.service
+sudo systemctl daemon-reload
+```
+
+### Remove Files
+
+```bash
+sudo rm -rf /opt/kryten-moderator
+sudo rm -rf /etc/kryten/moderator
+sudo rm -rf /var/log/kryten-moderator
+```
+
+### Remove User
+
+```bash
+sudo userdel kryten
+```

kryten_moderator-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kryten Robot Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kryten_moderator-0.1.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: kryten-moderator
+Version: 0.1.0
+Summary: Kryten moderation service - handles chat moderation and filtering
+License: MIT
+License-File: LICENSE
+Keywords: cytube,moderation,chat,nats,microservices
+Author: Kryten Robot Team
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: kryten-py (>=0.6.0,<0.7.0)
+Project-URL: Documentation, https://github.com/grobertson/kryten-moderator/blob/main/README.md
+Project-URL: Homepage, https://github.com/grobertson/kryten-moderator
+Project-URL: Repository, https://github.com/grobertson/kryten-moderator
+Description-Content-Type: text/markdown
+
+"# 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:
+```bash
+poetry install
+```
+
+2. Copy the example configuration:
+```bash
+cp config.example.json config.json
+```
+
+3. Edit `config.json` with your settings:
+```json
+{
+  "nats_url": "nats://localhost:4222",
+  "nats_subject_prefix": "cytube",
+  "service_name": "kryten-moderator"
+}
+```
+
+## Usage
+
+### Running the Service
+
+Using Poetry:
+```bash
+poetry run kryten-moderator --config config.json
+```
+
+Using the startup script (PowerShell):
+```powershell
+.\start-moderator.ps1
+```
+
+Using the startup script (Bash):
+```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
+
+```bash
+poetry run pytest
+```
+
+### Linting
+
+```bash
+poetry run ruff check .
+```
+
+### Formatting
+
+```bash
+poetry run black .
+```
+
+## License
+
+MIT License - see LICENSE file for details
+" 
+

kryten_moderator-0.1.0/README.md

@@ -0,0 +1,96 @@
+"# 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:
+```bash
+poetry install
+```
+
+2. Copy the example configuration:
+```bash
+cp config.example.json config.json
+```
+
+3. Edit `config.json` with your settings:
+```json
+{
+  "nats_url": "nats://localhost:4222",
+  "nats_subject_prefix": "cytube",
+  "service_name": "kryten-moderator"
+}
+```
+
+## Usage
+
+### Running the Service
+
+Using Poetry:
+```bash
+poetry run kryten-moderator --config config.json
+```
+
+Using the startup script (PowerShell):
+```powershell
+.\start-moderator.ps1
+```
+
+Using the startup script (Bash):
+```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
+
+```bash
+poetry run pytest
+```
+
+### Linting
+
+```bash
+poetry run ruff check .
+```
+
+### Formatting
+
+```bash
+poetry run black .
+```
+
+## License
+
+MIT License - see LICENSE file for details
+" 

kryten_moderator-0.1.0/kryten_moderator/__init__.py

@@ -0,0 +1,22 @@
+"""Kryten Moderator Service - Chat moderation and filtering."""
+
+import os
+from pathlib import Path
+
+
+def _read_version() -> str:
+    """Read version from VERSION file."""
+    # Try package root first
+    version_file = Path(__file__).parent / "VERSION"
+    if version_file.exists():
+        return version_file.read_text().strip()
+
+    # Try repository root
+    version_file = Path(__file__).parent.parent / "VERSION"
+    if version_file.exists():
+        return version_file.read_text().strip()
+
+    return "0.0.0"
+
+
+__version__ = _read_version()

kryten_moderator-0.1.0/kryten_moderator/__main__.py

@@ -0,0 +1,81 @@
+"""Main entry point for kryten-moderator service."""
+
+import argparse
+import asyncio
+import logging
+import signal
+import sys
+from pathlib import Path
+
+from kryten_moderator.service import ModeratorService
+
+
+def setup_logging(level: str = "INFO") -> None:
+    """Configure logging for the service."""
+    logging.basicConfig(
+        level=getattr(logging, level.upper()),
+        format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+        handlers=[logging.StreamHandler(sys.stdout)],
+    )
+
+
+def parse_args() -> argparse.Namespace:
+    """Parse command line arguments."""
+    parser = argparse.ArgumentParser(description="Kryten Moderator Service")
+    parser.add_argument(
+        "--config",
+        type=Path,
+        default=Path("/etc/kryten/moderator/config.json"),
+        help="Path to configuration file (default: /etc/kryten/moderator/config.json)",
+    )
+    parser.add_argument(
+        "--log-level",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR"],
+        default="INFO",
+        help="Logging level (default: INFO)",
+    )
+    return parser.parse_args()
+
+
+async def main_async() -> None:
+    """Main async entry point."""
+    args = parse_args()
+    setup_logging(args.log_level)
+
+    logger = logging.getLogger(__name__)
+    logger.info("Starting Kryten Moderator Service")
+
+    service = ModeratorService(config_path=args.config)
+
+    # Setup signal handlers
+    loop = asyncio.get_event_loop()
+
+    def signal_handler(sig: int) -> None:
+        logger.info(f"Received signal {sig}, shutting down...")
+        asyncio.create_task(service.stop())
+
+    for sig in (signal.SIGTERM, signal.SIGINT):
+        loop.add_signal_handler(sig, lambda s=sig: signal_handler(s))
+
+    try:
+        await service.start()
+        await service.wait_for_shutdown()
+    except KeyboardInterrupt:
+        logger.info("Keyboard interrupt received")
+    except Exception as e:
+        logger.error(f"Service error: {e}", exc_info=True)
+        sys.exit(1)
+    finally:
+        await service.stop()
+
+
+def main() -> None:
+    """Main entry point."""
+    try:
+        asyncio.run(main_async())
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

kryten_moderator-0.1.0/kryten_moderator/config.py

@@ -0,0 +1,42 @@
+"""Configuration management for kryten-moderator."""
+
+import json
+from pathlib import Path
+from typing import Any
+
+
+class Config:
+    """Service configuration."""
+
+    def __init__(self, config_path: Path):
+        """Initialize configuration from file."""
+        self.config_path = config_path
+        self._config: dict[str, Any] = {}
+        self.load()
+
+    def load(self) -> None:
+        """Load configuration from file."""
+        if not self.config_path.exists():
+            raise FileNotFoundError(f"Configuration file not found: {self.config_path}")
+
+        with open(self.config_path, encoding="utf-8") as f:
+            self._config = json.load(f)
+
+    def get(self, key: str, default: Any = None) -> Any:
+        """Get configuration value."""
+        return self._config.get(key, default)
+
+    @property
+    def nats_url(self) -> str:
+        """Get NATS server URL."""
+        return self.get("nats_url", "nats://localhost:4222")
+
+    @property
+    def nats_subject_prefix(self) -> str:
+        """Get NATS subject prefix."""
+        return self.get("nats_subject_prefix", "cytube")
+
+    @property
+    def service_name(self) -> str:
+        """Get service name."""
+        return self.get("service_name", "kryten-moderator")

kryten_moderator-0.1.0/kryten_moderator/service.py

@@ -0,0 +1,74 @@
+"""Main service class for kryten-moderator."""
+
+import asyncio
+import logging
+from pathlib import Path
+
+from kryten import KrytenClient
+
+from kryten_moderator.config import Config
+
+logger = logging.getLogger(__name__)
+
+
+class ModeratorService:
+    """Kryten Moderator Service."""
+
+    def __init__(self, config_path: Path):
+        """Initialize the service."""
+        self.config = Config(config_path)
+        self.client = KrytenClient(
+            nats_url=self.config.nats_url,
+            subject_prefix=self.config.nats_subject_prefix,
+            service_name=self.config.service_name,
+        )
+        self._shutdown_event = asyncio.Event()
+
+    async def start(self) -> None:
+        """Start the service."""
+        logger.info("Starting moderator service")
+
+        # Connect to NATS
+        await self.client.connect()
+
+        # Subscribe to events
+        await self.client.subscribe("chatMsg", self._handle_chat_message)
+        await self.client.subscribe("addUser", self._handle_add_user)
+
+        logger.info("Moderator service started")
+
+    async def stop(self) -> None:
+        """Stop the service."""
+        logger.info("Stopping moderator service")
+        self._shutdown_event.set()
+
+        # Disconnect from NATS
+        await self.client.disconnect()
+
+        logger.info("Moderator service stopped")
+
+    async def wait_for_shutdown(self) -> None:
+        """Wait for shutdown signal."""
+        await self._shutdown_event.wait()
+
+    async def _handle_chat_message(self, subject: str, data: dict) -> None:
+        """Handle chatMsg events."""
+        username = data.get("username", "unknown")
+        msg = data.get("msg", "")
+        logger.info(f"Chat message from {username}: {msg}")
+
+        # TODO: Add moderation logic here
+        # - Check for spam
+        # - Check for banned words
+        # - Check for excessive caps
+        # - etc.
+
+    async def _handle_add_user(self, subject: str, data: dict) -> None:
+        """Handle addUser events."""
+        name = data.get("name", "unknown")
+        logger.info(f"User added: {name}")
+
+        # TODO: Add user tracking logic here
+        # - Track user joins
+        # - Check against ban lists
+        # - etc.

kryten_moderator-0.1.0/pyproject.toml

@@ -0,0 +1,73 @@
+[tool.poetry]
+name = "kryten-moderator"
+version = "0.1.0"
+description = "Kryten moderation service - handles chat moderation and filtering"
+authors = ["Kryten Robot Team"]
+readme = "README.md"
+license = "MIT"
+homepage = "https://github.com/grobertson/kryten-moderator"
+repository = "https://github.com/grobertson/kryten-moderator"
+documentation = "https://github.com/grobertson/kryten-moderator/blob/main/README.md"
+keywords = ["cytube", "moderation", "chat", "nats", "microservices"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Communications :: Chat",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+packages = [{include = "kryten_moderator"}]
+include = ["systemd/*.service", "systemd/README.md", "INSTALL.md"]
+exclude = ["config.json", "config-*.json", "logs/*", "*.log"]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+kryten-py = "^0.6.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.0.0"
+pytest-asyncio = "^0.24.0"
+pytest-mock = "^3.14.0"
+black = "^23.0.0"
+ruff = "^0.1.0"
+mypy = "^1.7.0"
+
+[tool.poetry.scripts]
+kryten-moderator = "kryten_moderator.__main__:main"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+addopts = "-v"
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+
+[tool.black]
+line-length = 100
+target-version = ['py310']
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N"]
+ignore = ["E501"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["E402", "F401"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false

kryten_moderator-0.1.0/systemd/README.md

@@ -0,0 +1,57 @@
+# Systemd Service Files
+
+This directory contains systemd service unit files for running kryten-moderator as a system service.
+
+## Installation
+
+1. Copy the service file to systemd directory:
+```bash
+sudo cp systemd/kryten-moderator.service /etc/systemd/system/
+```
+
+2. Reload systemd daemon:
+```bash
+sudo systemctl daemon-reload
+```
+
+3. Enable the service to start on boot:
+```bash
+sudo systemctl enable kryten-moderator
+```
+
+4. Start the service:
+```bash
+sudo systemctl start kryten-moderator
+```
+
+## Service Management
+
+Check service status:
+```bash
+sudo systemctl status kryten-moderator
+```
+
+View logs:
+```bash
+sudo journalctl -u kryten-moderator -f
+```
+
+Stop the service:
+```bash
+sudo systemctl stop kryten-moderator
+```
+
+Restart the service:
+```bash
+sudo systemctl restart kryten-moderator
+```
+
+## Configuration
+
+The service expects:
+- Installation directory: `/opt/kryten-moderator`
+- Configuration file: `/etc/kryten/moderator/config.json`
+- User/Group: `kryten`
+- Log directory: `/var/log/kryten-moderator`
+
+Make sure to create these directories and the kryten user before starting the service.

kryten_moderator-0.1.0/systemd/kryten-moderator.service

@@ -0,0 +1,28 @@
+[Unit]
+Description=Kryten Moderator Service
+After=network.target nats.service
+Wants=nats.service
+
+[Service]
+Type=simple
+User=kryten
+Group=kryten
+WorkingDirectory=/opt/kryten-moderator
+Environment="PATH=/opt/kryten-moderator/.venv/bin:/usr/local/bin:/usr/bin:/bin"
+ExecStart=/opt/kryten-moderator/.venv/bin/kryten-moderator --config /etc/kryten/moderator/config.json
+Restart=on-failure
+RestartSec=5
+StandardOutput=journal
+StandardError=journal
+SyslogIdentifier=kryten-moderator
+
+# Security hardening
+NoNewPrivileges=true
+PrivateTmp=true
+ProtectSystem=strict
+ProtectHome=true
+ReadWritePaths=/var/log/kryten-moderator
+ReadOnlyPaths=/etc/kryten/moderator
+
+[Install]
+WantedBy=multi-user.target