Update ghcr.io/astral-sh/uv Docker tag to v0.9.28

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

@@ -0,0 +1,41 @@
+"""Main file for bot."""
+
+import os
+
+import nextcord
+from nextcord.ext import commands
+
+from .settings import settings
+
+
+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
+    intents = nextcord.Intents.default()
+
+    # Required in order to read messages (eg. prefix commands)
+    intents.message_content = True
+
+    # To enable the guilds privileged intent:
+    # intents.guilds = True
+
+    # To enable the members privileged intent:
+    # intents.members = True
+
+    bot = commands.Bot(intents=intents)
+
+    # Get the modules of all cogs whose directory structure is ./cogs/<module_name>
+    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:
+        """When Discord is connected."""
+        if bot.user is None:
+            print("Discord connection failed.")
+            return
+        print(f"{bot.user.name} has connected to Discord!")
+
+    # Run Discord bot
+    bot.run(settings.params.discord_token)

$REPO_NAME_SNAKE/cogs/commands/__init__.py

@@ -1,16 +1,12 @@
-"""
+"""Cog loader. Adds all command cogs to the bot."""
-Cog loader. Adds all command cogs to the bot.
-"""
 
 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.
 # It is necessary to add these functions to the bot.
-def setup(bot: commands.Bot):
+def setup(bot: commands.Bot) -> None:
-    """
+    """Add all command classes to bot."""
-    Adds all command classes to bot.
-    """
     bot.add_cog(HiCog(bot))

$REPO_NAME_SNAKE/cogs/commands/hi.py

@@ -1,29 +1,22 @@
-"""
+"""Example command file."""
-Example command file.
-"""
 
 import nextcord
 from nextcord.ext import commands
 
 
 class HiCog(commands.Cog, name="Test commands."):
-    """
+    """Class holds commands for testing."""
-    Class holds commands for testing.
-    """
 
-    def __init__(self, bot) -> None:
+    def __init__(self, bot: commands.Bot) -> None:
-        """
-        Default constructor for HelpCog class. Does nothing.
-        """
         self.bot = bot
 
     @nextcord.slash_command()
-    async def hi(self, interaction: nextcord.Interaction):
+    async def hi(self, interaction: nextcord.Interaction) -> None:
         """
-        Says hi
+        Says hi.
 
         Args:
             interaction (nextcord.Interaction): Interaction to reply to.
-        """
 
+        """
         await interaction.response.send_message("Hi!", ephemeral=True)

$REPO_NAME_SNAKE/settings.py

@@ -0,0 +1,28 @@
+"""File contains classes defining ${REPO_NAME} settings structure."""
+
+from dataclasses import dataclass
+
+from dataclass_wizard import YAMLWizard
+
+CONFIG_LOCATION = "conf/config.yaml"
+
+
+@dataclass
+class Params:
+    """Class defines start parameters that shouldn't be changed."""
+
+    discord_token: str
+
+
+@dataclass
+class Settings(YAMLWizard):
+    """Class defines all configs required for ${REPO_NAME}."""
+
+    params: Params
+
+    def save(self) -> None:
+        """Save settings to the yaml file."""
+        self.to_yaml_file(CONFIG_LOCATION)
+
+
+settings = Settings.from_yaml_file(CONFIG_LOCATION)

.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,3 +1,5 @@
+$REPO_NAME_SNAKE/**
 .gitea/workflows/*.yml
-main.py
+.vscode/launch.json
 pyproject.toml
+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@v3
         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@v3
         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@v3
         with:
           registry: gitea.cheezers.org
           username: ${REPO_OWNER}

.vscode/extensions.json

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

.vscode/launch.json

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

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.analysis.diagnosticSeverityOverrides": {
+        "reportOptionalMemberAccess": "warning",
+        "reportArgumentType": "information",
+        "reportAttributeAccessIssue": "warning"
+    }
+}

Dockerfile

@@ -1,13 +1,12 @@
-FROM python:3.11.9-slim
+FROM python:3.13.7-slim
 
+# install uv
+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
+RUN uv sync --frozen --no-dev
 
-COPY config.py config.py
+CMD ["uv", "run", "--frozen", "--no-dev", "-m", "${REPO_NAME_SNAKE}"]
-COPY main.py main.py
-COPY pyproject.toml pyproject.toml
-
-COPY cogs cogs/
-
-RUN pip install --upgrade pip && pip install poetry && poetry export -f requirements.txt --output requirements.txt && pip install -r requirements.txt
-
-CMD ["python3", "-u", "./main.py"]

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

main.py

@@ -1,65 +0,0 @@
-import logging
-import os
-import sys
-
-import hydra
-import nextcord
-from hydra.core.config_store import ConfigStore
-from nextcord.ext import commands
-
-from config import BotConfig
-
-cs = ConfigStore.instance()
-cs.store(name="${REPO_NAME}_config", node=BotConfig)
-
-logger = logging.getLogger("nextcord")
-logger.setLevel(logging.DEBUG)
-handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
-handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
-logger.addHandler(handler)
-
-
-@hydra.main(config_path="conf", config_name="config")
-def main(cfg: BotConfig):
-    """
-    Main function for the bot. Sets config, intents, then connects the bot to discord.
-
-    Args:
-        cfg (BotConfig): The local configs to use.
-    """
-
-    # Allows privledged intents for monitoring members joining, roles editing, and role assignments
-    # These need to be enabled in the developer portal as well
-    intents = nextcord.Intents.default()
-
-    # Required in order to read messages (eg. prefix commands)
-    intents.message_content = True
-
-    # To enable the guilds priveleged intent:
-    # intents.guilds = True
-
-    # To enable the members priveleged intent:
-    # intents.members = True
-
-    bot = commands.Bot(intents=intents)
-    bot.config = cfg
-
-    # 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}")
-
-    @bot.listen()
-    async def on_ready():
-        """When Discord is connected"""
-        assert bot.user is not None
-        print(f"{bot.user.name} has connected to Discord!")
-
-    # Run Discord bot
-    bot.run(bot.config.params.discord_token)
-
-
-if __name__ == "__main__":
-    sys.argv.append("hydra.job.chdir=False")
-    sys.argv.append("hydra/job_logging=none")
-    sys.argv.append("hydra/hydra_logging=none")
-    main()  # pylint: disable=no-value-for-parameter

pyproject.toml

@@ -1,21 +1,20 @@
-[tool.poetry]
+[project]
 name = "${REPO_NAME}"
 version = "0.1.0"
 description = ""
-authors = ["${REPO_OWNER}"]
+authors = [{name="${REPO_OWNER}", email=""}]
 readme = "README.md"
+dependencies = [
+    "nextcord>=2.6.0",
+    "sqlmodel>=0.0.22",
+    "dataclass-wizard[yaml]>=0.22.3,<1.0.0",
+]
+requires-python = ">=3.12"
 
-[tool.poetry.dependencies]
+[tool.uv]
-python = "^3.11"
+dev-dependencies = ["ruff>=0.7.2"]
-hydra-core = "1.3.2"
-nextcord = "2.6.1"
-python-dotenv = "1.0.0"
 
 
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
 [tool.ruff]
 # Exclude a variety of commonly ignored directories.
 exclude = [
@@ -58,8 +57,28 @@ target-version = "py38"
 # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
 # Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
 # McCabe complexity (`C901`) by default.
-select = ["E4", "E7", "E9", "F", "D100", "D1"]
+select = ["ALL"]
-ignore = ["D107"]
+ignore = [
+    "B008",   # I build SlashOptions as arguments.
+    "COM812",
+    "COM819",
+    "D107",   # don't want docstrings on init functions
+    "D203",
+    "D206",
+    "D212",
+    "D300",
+    "E111",
+    "E114",
+    "E117",
+    "ISC001",
+    "ISC002",
+    "PD011",  # doesn't like me using '.values' on embeds....
+    "Q000",
+    "Q001",
+    "Q002",
+    "Q003",
+    "W191",
+]
 
 # Allow fix for all enabled rules (when `--fix`) is provided.
 fixable = ["ALL"]

renovate.json

@@ -0,0 +1,29 @@
+{
+    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+    "lockFileMaintenance": {
+        "automerge": true
+    },
+    "major": {
+        "automerge": false,
+        "automergeType": "pr"
+    },
+    "minor": {
+        "automerge": true,
+        "automergeType": "branch"
+    },
+    "patch": {
+        "automerge": true,
+        "automergeType": "branch"
+    },
+    "pin": {
+        "automerge": true,
+        "automergeType": "branch"
+    },
+    "ignoreTests": true,
+    "dockerfile": {
+        "minor": {
+            "automerge": false,
+            "automergeType": "pr"
+        }
+    }
+}

requirements.txt

@@ -1,2 +0,0 @@
-nextcord==2.4.2
-hydra-core==1.3.2