Update docker/login-action action to v4

Reviewed-on: #9
Reviewed-by: imcompiling <[email protected]>

$REPO_NAME_SNAKE/__init__.py

@@ -0,0 +1 @@
+"""Empty init file for ${REPO_NAME_SNAKE} module."""

$REPO_NAME_SNAKE/__main__.py

@@ -0,0 +1,14 @@
+"""Starts the app for off_cooldown_bot."""
+
+import logging
+
+from .app import run
+
+nextcord_logger = logging.getLogger("nextcord")
+nextcord_logger.setLevel(logging.DEBUG)
+nextcord_handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
+nextcord_handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
+nextcord_logger.addHandler(nextcord_handler)
+
+if __name__ == "__main__":
+    run()

$REPO_NAME_SNAKE/app.py

@@ -1,21 +1,14 @@
 """Main file for bot."""
 
-import logging
 import os
 
 import nextcord
 from nextcord.ext import commands
 
-from settings import settings
-
-nextcord_logger = logging.getLogger("nextcord")
-nextcord_logger.setLevel(logging.DEBUG)
-nextcord_handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
-nextcord_handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
-nextcord_logger.addHandler(nextcord_handler)
+from .settings import settings
 
 
-def main() -> None:
+def run() -> None:
     """Set config, intents, then connects the bot to discord."""
     # Allows privileged intents for monitoring members joining, roles editing, and role assignments
     # These need to be enabled in the developer portal as well
@@ -33,8 +26,8 @@ def main() -> None:
     bot = commands.Bot(intents=intents)
 
     # Get the modules of all cogs whose directory structure is ./cogs/<module_name>
-    for folder in os.listdir("cogs"):
-        bot.load_extension(f"cogs.{folder}")
+    for folder in os.listdir(f"${REPO_NAME_SNAKE}/cogs"):
+        bot.load_extension(f"${REPO_NAME_SNAKE}.cogs.{folder}")
 
     @bot.listen()
     async def on_ready() -> None:
@@ -46,7 +39,3 @@ def main() -> None:
 
     # Run Discord bot
     bot.run(settings.params.discord_token)
-
-
-if __name__ == "__main__":
-    main()

$REPO_NAME_SNAKE/cogs/commands/__init__.py

@@ -2,7 +2,7 @@
 
 from nextcord.ext import commands
 
-from cogs.commands.hi import HiCog
+from .hi import HiCog
 
 
 # This function will be called when this extension is loaded.

$REPO_NAME_SNAKE/cogs/commands/hi.py

@@ -7,7 +7,7 @@ from nextcord.ext import commands
 class HiCog(commands.Cog, name="Test commands."):
     """Class holds commands for testing."""
 
-    def __init__(self, bot: nextcord.Bot) -> None:
+    def __init__(self, bot: commands.Bot) -> None:
         self.bot = bot
 
     @nextcord.slash_command()

.dockerignore

@@ -0,0 +1,2 @@
+.*
+Dockerfile

.editorconfig

@@ -0,0 +1,16 @@
+# see https://editorconfig.org/
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.gitea/template

@@ -1,4 +1,5 @@
+$REPO_NAME_SNAKE/**
 .gitea/workflows/*.yml
-main.py
+.vscode/launch.json
 pyproject.toml
-settings.py
+Dockerfile

.gitea/workflows/build_develop.yaml

@@ -1,19 +1,25 @@
 name: build_develop
 
-on: [push]
+on:
+  push:
+    branches:
+      - "*"
+      - "!main"
+    paths-ignore:
+      - "README.md"
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Install Docker
         uses: https://github.com/papodaca/install-docker-action@v1
       - name: Log into container registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v4
         with:
           registry: gitea.cheezers.org
           username: ${REPO_OWNER}

.gitea/workflows/build_latest.yaml

@@ -3,19 +3,21 @@ name: build_latest
 on:
   push:
     branches: [main]
+    paths-ignore:
+      - "README.md"
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Install Docker
         uses: https://github.com/papodaca/install-docker-action@v1
       - name: Log into container registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v4
         with:
           registry: gitea.cheezers.org
           username: ${REPO_OWNER}

.gitea/workflows/build_release.yaml

@@ -9,13 +9,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Install Docker
         uses: https://github.com/papodaca/install-docker-action@v1
       - name: Log into container registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v4
         with:
           registry: gitea.cheezers.org
           username: ${REPO_OWNER}

.vscode/extensions.json

@@ -1,8 +1,9 @@
 {
   "recommendations": [
-    "ms-python.vscode-pylance",
-    "ms-python.python",
-    "ms-python.debugpy",
-    "charliermarsh.ruff"
+      "ms-python.vscode-pylance",
+      "ms-python.python",
+      "ms-python.debugpy",
+      "charliermarsh.ruff",
+      "editorconfig.editorconfig"
   ]
 }

.vscode/launch.json

@@ -1,15 +1,15 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Python: Module",
-      "type": "debugpy",
-      "request": "launch",
-      "module": "main",
-      "justMyCode": true
-    }
-  ]
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Module",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "${REPO_NAME_SNAKE}",
+            "justMyCode": true
+        }
+    ]
 }

Dockerfile

@@ -1,16 +1,12 @@
-FROM python:3.12.3-slim
+FROM python:3.13.7-slim
 
 # install uv
-COPY --from=ghcr.io/astral-sh/uv:0.6.5 /uv /uvx /bin/
+COPY --from=ghcr.io/astral-sh/uv:0.9.28 /uv /uvx /bin/
 
+COPY . /home
+
+# Sync the project into a new environment, using the frozen lockfile
 WORKDIR /home
-
-COPY config.py config.py
-COPY main.py main.py
-COPY pyproject.toml pyproject.toml
-
-COPY cogs cogs/
-
 RUN uv sync --frozen --no-dev
 
-CMD ["uv", "run", "./main.py"]
+CMD ["uv", "run", "--frozen", "--no-dev", "-m", "${REPO_NAME_SNAKE}"]

config.py

@@ -1,22 +0,0 @@
-"""
-File contains classes defining the Hydra configuraton structure.
-"""
-from dataclasses import dataclass
-
-
-@dataclass
-class Params:
-    """
-    Class defines the various configuration parameters.
-    """
-
-    discord_token: str
-
-
-@dataclass
-class BotConfig:
-    """
-    Class defines all configs required for Dakiny Bot.
-    """
-
-    params: Params

pyproject.toml

@@ -6,7 +6,6 @@ authors = [{name="${REPO_OWNER}", email=""}]
 readme = "README.md"
 dependencies = [
     "nextcord>=2.6.0",
-    "python-dotenv>=1.0.1",
     "sqlmodel>=0.0.22",
     "dataclass-wizard[yaml]>=0.22.3,<1.0.0",
 ]