Merge branch 'main' into example-cog

Author: electron271

tux/cogs/guild/export.py renamed to .archive/export.py

@@ -0,0 +1,171 @@
+{
+  "rules": [
+    {
+      "name": "Verify Information",
+      "pattern": "(?i)\\b(assume|assumption|guess|speculate)\\b",
+      "message": "Always verify information before presenting it. Do not make assumptions or speculate without clear evidence."
+    },
+    {
+      "name": "Preserve Existing Code",
+      "pattern": "(?i)\\b(remove|delete|eliminate|destroy)\\b",
+      "message": "Don't remove unrelated code or functionalities. Pay attention to preserving existing structures."
+    },
+    {
+      "name": "No Apologies",
+      "pattern": "(?i)\\b(sorry|apologize|apologies)\\b",
+      "message": "Never use apologies."
+    },
+    {
+      "name": "No Understanding Feedback",
+      "pattern": "(?i)\\b(understand|understood|got it)\\b",
+      "message": "Avoid giving feedback about understanding in comments or documentation."
+    },
+    {
+      "name": "No Whitespace Suggestions",
+      "pattern": "(?i)\\b(whitespace|indentation|spacing)\\b",
+      "message": "Don't suggest whitespace changes."
+    },
+    {
+      "name": "No Summaries",
+      "pattern": "(?i)\\b(summary|summarize|overview)\\b",
+      "message": "Don't summarize changes made."
+    },
+    {
+      "name": "No Inventions",
+      "pattern": "(?i)\\b(suggest|recommendation|propose)\\b",
+      "message": "Don't invent changes other than what's explicitly requested."
+    },
+    {
+      "name": "No Unnecessary Confirmations",
+      "pattern": "(?i)\\b(make sure|confirm|verify|check)\\b",
+      "message": "Don't ask for confirmation of information already provided in the context."
+    },
+    {
+      "name": "Single Chunk Edits",
+      "pattern": "(?i)\\b(first|then|next|after that|finally)\\b",
+      "message": "Provide all edits in a single chunk instead of multiple-step instructions or explanations for the same file."
+    },
+    {
+      "name": "No Implementation Checks",
+      "pattern": "(?i)\\b(make sure|verify|check|confirm) (it's|it is|that) (correctly|properly) implemented\\b",
+      "message": "Don't ask the user to verify implementations that are visible in the provided context."
+    },
+    {
+      "name": "No Unnecessary Updates",
+      "pattern": "(?i)\\b(update|change|modify|alter)\\b.*\\bno changes\\b",
+      "message": "Don't suggest updates or changes to files when there are no actual modifications needed."
+    },
+    {
+      "name": "Provide Real File Links",
+      "pattern": "(?i)\\b(file|in)\\b.*\\b(x\\.md)\\b",
+      "message": "Always provide links to the real files, not x.md."
+    },
+    {
+      "name": "No Current Implementation",
+      "pattern": "(?i)\\b(current|existing)\\s+(implementation|code)\\b",
+      "message": "Don't show or discuss the current implementation unless specifically requested."
+    },
+    {
+      "name": "Check Context Generated File Content",
+      "pattern": "(?i)\\b(file|content|implementation)\\b",
+      "message": "Remember to check the context generated file for the current file contents and implementations."
+    },
+    {
+      "name": "Use Descriptive Variable Names",
+      "pattern": "(?i)\\b(var|x|temp)\\b",
+      "message": "Prefer descriptive, explicit variable names over short, ambiguous ones to enhance code readability."
+    },
+    {
+      "name": "Follow Consistent Coding Style",
+      "pattern": "(?i)\\b(not consistent|different style)\\b",
+      "message": "Adhere to the existing coding style in the project for consistency."
+    },
+    {
+      "name": "Prioritize Performance",
+      "pattern": "(?i)\\b(slow|inefficient)\\b",
+      "message": "When suggesting changes, consider and prioritize code performance where applicable."
+    },
+    {
+      "name": "Security-First Approach",
+      "pattern": "(?i)\\b(insecure|vulnerable)\\b",
+      "message": "Always consider security implications when modifying or suggesting code changes."
+    },
+    {
+      "name": "Error Handling",
+      "pattern": "(?i)\\b(missing error|no exception)\\b",
+      "message": "Implement robust error handling and logging where necessary."
+    },
+    {
+      "name": "Modular Design",
+      "pattern": "(?i)\\b(mixed responsibilities|not modular)\\b",
+      "message": "Encourage modular design principles to improve code maintainability and reusability."
+    },
+    {
+      "name": "Avoid Magic Numbers",
+      "pattern": "(?i)\\b\\b\\d{2,}\\b",
+      "message": "Replace hardcoded values with named constants to improve code clarity and maintainability."
+    },
+    {
+      "name": "Consider Edge Cases",
+      "pattern": "(?i)\\b(edge case|not handled)\\b",
+      "message": "When implementing logic, always consider and handle potential edge cases."
+    },
+    {
+      "name": "Use Assertions",
+      "pattern": "(?i)\\b(no assertion|missing assert)\\b",
+      "message": "Include assertions wherever possible to validate assumptions and catch potential errors early."
+    }
+  ],
+  "coding_practices": {
+    "modularity": true,
+    "DRY_principle": true,
+    "performance_optimization": true,
+    "documentation": {
+      "require_docs": true,
+      "doc_tool": "docstrings",
+      "style_guide": "Numpy"
+    },
+    "error_handling": {
+      "prefer_try_catch": true,
+      "log_errors": true
+    },
+    "naming_conventions": {
+      "variables": "snake_case",
+      "functions": "snake_case",
+      "classes": "PascalCase",
+      "interfaces": "PascalCase",
+      "files": "snake_case"
+    }
+  },
+  "project_configuration": {
+    "language": "Python",
+    "version": "3.13.2",
+    "dependencies": {
+      "management_tool": "Poetry",
+      "libraries": [
+        "discord.py",
+        "pyright",
+        "prisma",
+        "ruff",
+        "loguru",
+        "httpx",
+        "pre-commit",
+        "sentry-sdk",
+        "python-dotenv",
+        "pytz",
+        "pillow",
+        "rich",
+        "aiofiles",
+        "reactionmenu"
+      ]
+    },
+    "development": {
+      "environment": "Docker",
+      "deployment_tool": "Docker Compose"
+    },
+    "error_handling": {
+      "logging_tool": "Loguru",
+      "exception_management": "Sentry and handlers/error.py"
+    }
+  }
+}

tux/utils/exports.py renamed to .archive/exports.py

@@ -4,3 +4,18 @@
 .github/
 .venv/
 .vscode/
+.cache/
+__pycache__/
+*.pyc
+assets/
+.archive/
+docs/
+docs-build/
+site/
+.markdownlint.yaml
+.mise.toml
+.python-version
+.pre-commit-config.yaml
+.gitignore
+.cursorrules
+.editorconfig

tux/cogs/moderation/roles.py renamed to .archive/roles.py

@@ -1,39 +1,69 @@
-#
-# Required
-#
+# Tux Environment Configuration (.env.example)
+# -------------------------------------------
+# Copy this file to .env and fill in the values.
+# Do NOT commit your actual .env file to version control.
 
-# If in production mode:
+# Core Requirements
+# -----------------
+# These variables are fundamental and required depending on the mode.
 
-# DEV=False
+# Database URLs (Required: one depending on mode)
+# The application uses DEV_DATABASE_URL when run with '--dev' flag,
+# and PROD_DATABASE_URL otherwise (production mode).
+DEV_DATABASE_URL=""
 PROD_DATABASE_URL=""
-PROD_TOKEN=""
 
-# If in development mode:
+# Bot Tokens (Required: one depending on mode)
+# The application uses DEV_BOT_TOKEN when run with '--dev' flag,
+# and PROD_BOT_TOKEN otherwise (production mode).
+DEV_BOT_TOKEN=""
+PROD_BOT_TOKEN=""
 
-# DEV=True
-DEV_DATABASE_URL=""
-DEV_TOKEN=""
+# Development Specific Settings
+# ---------------------------
+# These settings primarily affect development mode ('--dev').
+
+# Cogs to ignore during development (Optional, comma-separated)
+# Example: DEV_COG_IGNORE_LIST="somecog,anothercog"
+DEV_COG_IGNORE_LIST="rolecount,mail,git" # Default ignores ATL-specific cogs
+
+# Production Specific Settings
+# --------------------------
+# These settings primarily affect production mode (no '--dev' flag).
+
+# Cogs to ignore in production (Optional, comma-separated)
+# Example: PROD_COG_IGNORE_LIST="debugcog"
+PROD_COG_IGNORE_LIST="rolecount,mail,git" # Default ignores ATL-specific cogs
 
-#
-# Optional
-#
+# Optional Feature Configuration
+# ----------------------------
+# Fill these variables to enable optional integrations.
 
-SENTRY_URL=""
+# Sentry (Error Tracking)
+# SENTRY_URL=""
 
-PROD_COG_IGNORE_LIST="rolecount,mail" # These are ATL specific cogs that are not needed in Tux unless you are ATL
-DEV_COG_IGNORE_LIST=
+# InfluxDB (Metrics/Logging)
+# ------------------
 
-GITHUB_APP_ID=
-GITHUB_CLIENT_ID=""
-GITHUB_CLIENT_SECRET=""
-GITHUB_PUBLIC_KEY=""
-GITHUB_INSTALLATION_ID=
+# INFLUXDB_TOKEN=""
+# INFLUXDB_URL=""
+# INFLUXDB_ORG=""
 
-GITHUB_PRIVATE_KEY_BASE64=""
+# GitHub Integration
+# ------------------
+# These variables are used for the ATL GitHub integration that is is used for creating issues quickly.
+# You can safely ignore these until we have a proper way to guide using them multi guild/self hosted wise.
 
-GITHUB_REPO_URL=
-GITHUB_REPO_OWNER=
-GITHUB_REPO=
+# GITHUB_APP_ID=
+# GITHUB_CLIENT_ID=""
+# GITHUB_CLIENT_SECRET=""
+# GITHUB_PUBLIC_KEY=""
+# GITHUB_INSTALLATION_ID=
+# GITHUB_PRIVATE_KEY_BASE64="" # Base64 encoded private key
+# GITHUB_REPO_URL=
+# GITHUB_REPO_OWNER=
+# GITHUB_REPO=
 
-MAILCOW_API_KEY=
-MAILCOW_API_URL=
+# Mailcow Integration (Email related features)
+# MAILCOW_API_KEY=
+# MAILCOW_API_URL=

tux/cogs/utility/snippets.py renamed to .archive/snippets.py

@@ -1,5 +1,7 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "timezone": "America/New_York",
+  "schedule": ["* 0 * * 0"],
   "extends": [
     "config:recommended"
   ]

tux/ui/starboard/__init__.py renamed to .archive/starboard/__init__.py

@@ -1,15 +1,12 @@
-name: Create and Publish Docker Image CI
-
+name: "GHCR - Build and Push Docker Image"
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
 
 jobs:
-
   docker:
-
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -21,19 +18,22 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            ghcr.io/allthingslinux/tux            
+            ghcr.io/allthingslinux/tux
           tags: |
             type=raw,value=latest,enable={{is_default_branch}}
             type=ref,event=pr
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
+
       - name: Login to GHCR
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Build and push
         uses: docker/build-push-action@v6
         with:

tux/ui/starboard/image_gen.py renamed to .archive/starboard/image_gen.py

@@ -1,20 +1,20 @@
-name: 'Linting'
+name: "Ruff - Linting and Formatting"
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 permissions:
   contents: write
   issues: write
   pull-requests: write
 
 jobs:
-  Linting:
+  Ruff:
     runs-on: ubuntu-24.04
     steps:
-      - name: 'Checkout Repository'
+      - name: "Checkout Repository"
         uses: actions/checkout@v4
         with:
-          token: ${{ secrets.ADMIN_PAT || github.token }}
+          token: ${{ github.token }}
 
       # Install Python
       - name: Setup Python
@@ -31,4 +31,4 @@ jobs:
         run: ruff format && ruff check . --fix
       - uses: stefanzweifel/git-auto-commit-action@v5
         with:
-          commit_message: 'fix: Linting and formatting via Ruff'
+          commit_message: "chore: Linting and formatting via Ruff"