Correct database ignore.

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

.dockerignore

@@ -1,2 +1,5 @@
 .*
 Dockerfile
+LICENSE
+README.md
+renovate.json

.gitea/workflows/build_develop.yml

@@ -2,14 +2,18 @@ name: build_develop
 
 on:
   push:
-    branches: [main]
+    branches:
+      - "*"
+      - "!main"
+    paths-ignore:
+      - "README.md"
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Install Docker
@@ -20,7 +24,9 @@ jobs:
           registry: gitea.cheezers.org
           username: imcompiling
           password: ${{ secrets.PASSWORD }}
+      - name: set env
+        run: echo "GIT_BRANCH=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_ENV
       - name: Build Docker Image
-        run: docker build -t gitea.cheezers.org/imcompiling/agon:develop .
+        run: docker build -t gitea.cheezers.org/imcompiling/agon:${{env.GIT_BRANCH}} .
       - name: Push Docker Image
-        run: docker push gitea.cheezers.org/imcompiling/agon:develop
+        run: docker push gitea.cheezers.org/imcompiling/agon:${{env.GIT_BRANCH}}

.gitea/workflows/build_latest.yaml

@@ -0,0 +1,28 @@
+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
+        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@v3
+        with:
+          registry: gitea.cheezers.org
+          username: imcompiling
+          password: ${{ secrets.PASSWORD }}
+      - name: Build Docker Image
+        run: docker build -t gitea.cheezers.org/imcompiling/agon:latest .
+      - name: Push Docker Image
+        run: docker push gitea.cheezers.org/imcompiling/agon:latest

.gitea/workflows/build_release.yml

@@ -23,8 +23,6 @@ jobs:
       - name: Set env
         run: echo "GIT_TAG=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
       - name: Build Docker Images
-        run: docker build -t gitea.cheezers.org/imcompiling/agon:latest -t gitea.cheezers.org/imcompiling/agon:${{env.GIT_TAG}} .
-      - name: Push Latest Image
-        run: docker push gitea.cheezers.org/imcompiling/agon:latest
+        run: docker build -t gitea.cheezers.org/imcompiling/agon:${{env.GIT_TAG}} .
       - name: Push Tagged Image
         run: docker push gitea.cheezers.org/imcompiling/agon:${{env.GIT_TAG}}

.gitignore

@@ -135,4 +135,4 @@ deleted_backups/
 highscores_data/
 TODO.txt
 sql_tester.py
-database.db
+/database

.vscode/launch.json

@@ -8,7 +8,7 @@
             "name": "Python: Module",
             "type": "debugpy",
             "request": "launch",
-            "module": "main",
+            "module": "agon",
             "justMyCode": true
         }
     ]

Dockerfile

@@ -1,15 +1,15 @@
 FROM python:3.12.3-slim
 
 # install uv
-COPY --from=ghcr.io/astral-sh/uv:0.6.5 /uv /uvx /bin/
+COPY --from=ghcr.io/astral-sh/uv:0.6.6 /uv /uvx /bin/
 
 RUN apt-get update && apt-get -y upgrade && apt-get -y install sqlite3
 
 # Copy project to image
-ADD . /agon
+ADD . /home
 
 # Sync the project into a new environment, using the frozen lockfile
-WORKDIR /agon
+WORKDIR /home
 RUN uv sync --frozen --no-dev
 
-CMD ["uv", "run", "./main.py"]
+CMD ["uv", "run", "--frozen", "--no-dev", "-m", "agon"]

agon/__init__.py

@@ -0,0 +1 @@
+"""Empty init file for off_cooldown_bot module."""

agon/__main__.py

@@ -0,0 +1,14 @@
+"""Starts the app for agon."""
+
+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()

agon/app.py

@@ -1,23 +1,16 @@
 """Main file for Agon bot."""
 
-import logging
-import os
+import pathlib
 import sys
 
 import nextcord
 from nextcord.ext import commands
 
-from utilities import config
-from utilities.logger import agon_logger
-
-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 . import config
+from .logger import agon_logger
 
 
-def main() -> None:
+def run() -> None:
     """Main function for bot."""
     min_python_version = (3, 12)
     if sys.version_info < min_python_version:
@@ -34,8 +27,8 @@ def main() -> None:
     )
 
     # 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 pathlib.Path("./agon/cogs").iterdir():
+        bot.load_extension(f"agon.cogs.{folder.name}")
 
     @bot.listen()
     async def on_ready() -> None:
@@ -47,7 +40,3 @@ def main() -> None:
 
     # Run Discord bot
     bot.run(config.DISCORD_TOKEN)
-
-
-if __name__ == "__main__":
-    main()

agon/cogs/commands/__init__.py

@@ -2,15 +2,15 @@
 
 from nextcord.ext import commands
 
-from cogs.commands.create import CreateCog
-from cogs.commands.delete import DeleteCog
-from cogs.commands.get import GetCog
-from cogs.commands.help import HelpCog
-from cogs.commands.refresh import RefreshCog
-from cogs.commands.set import SetCog
-from cogs.commands.submission import SubmissionCog
-from cogs.commands.update import UpdateCog
-from cogs.commands.view import ViewCog
+from agon.cogs.commands.create import CreateCog
+from agon.cogs.commands.delete import DeleteCog
+from agon.cogs.commands.get import GetCog
+from agon.cogs.commands.help import HelpCog
+from agon.cogs.commands.refresh import RefreshCog
+from agon.cogs.commands.set import SetCog
+from agon.cogs.commands.submission import SubmissionCog
+from agon.cogs.commands.update import UpdateCog
+from agon.cogs.commands.view import ViewCog
 
 
 # This function will be called when this extension is loaded.

agon/cogs/commands/create.py

@@ -6,9 +6,9 @@ from sqlalchemy import exc, select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Category, CategoryGroup
-from utilities.utils import MAX_LINE_LENGTH, autofill_groups, send_highscore_message
+from agon.database.db import engine
+from agon.database.models import Category, CategoryGroup
+from agon.utils import MAX_LINE_LENGTH, autofill_groups, send_highscore_message
 
 
 class CreateCog(commands.Cog, name="Create Cog"):

agon/cogs/commands/delete.py

@@ -6,9 +6,9 @@ from sqlalchemy import distinct, select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Category, CategoryGroup, Score
-from utilities.utils import (
+from agon.database.db import engine
+from agon.database.models import Category, CategoryGroup, Score
+from agon.utils import (
     autofill_categories,
     autofill_groups,
     autofill_users_in_group_category,

agon/cogs/commands/get.py

@@ -4,9 +4,9 @@ import nextcord
 from nextcord.ext import commands
 from sqlmodel import Session, col, select
 
-from database.db import engine
-from database.models import Category, CategoryGroup
-from utilities.utils import autofill_categories, autofill_groups
+from agon.database.db import engine
+from agon.database.models import Category, CategoryGroup
+from agon.utils import autofill_categories, autofill_groups
 
 
 class GetCog(commands.Cog, name="Get command."):

agon/cogs/commands/refresh.py

@@ -6,9 +6,9 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import CategoryGroup
-from utilities.utils import autofill_groups, send_highscore_message
+from agon.database.db import engine
+from agon.database.models import CategoryGroup
+from agon.utils import autofill_groups, send_highscore_message
 
 
 class RefreshCog(commands.Cog, name="Refresh Cog"):

agon/cogs/commands/set.py

@@ -6,10 +6,10 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Category, CategoryGroup, Guild
-from utilities.logger import agon_logger
-from utilities.utils import MAX_LINE_LENGTH, autofill_categories, autofill_groups, send_highscore_message
+from agon.database.db import engine
+from agon.database.models import Category, CategoryGroup, Guild
+from agon.logger import agon_logger
+from agon.utils import MAX_LINE_LENGTH, autofill_categories, autofill_groups, send_highscore_message
 
 
 class SetCog(commands.Cog, name="Set command."):

agon/cogs/commands/submission.py

@@ -8,11 +8,11 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from cogs.submission.verification_view import VerificationView
-from database.db import engine
-from database.models import Category, CategoryGroup, Guild, Submission
-from main import agon_logger
-from utilities.utils import autofill_categories, autofill_groups, submit_score
+from agon.cogs.submission.verification_view import VerificationView
+from agon.database.db import engine
+from agon.database.models import Category, CategoryGroup, Guild, Submission
+from agon.logger import agon_logger
+from agon.utils import autofill_categories, autofill_groups, submit_score
 
 
 class SubmissionCog(commands.Cog):

agon/cogs/commands/update.py

@@ -6,9 +6,9 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Guild
-from utilities.utils import autofill_users_in_guild
+from agon.database.db import engine
+from agon.database.models import Guild
+from agon.utils import autofill_users_in_guild
 
 from .views.update_username_verify import UpdateUsernameVerifyView
 

agon/cogs/commands/view.py

@@ -7,9 +7,9 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Category, CategoryGroup, Score
-from utilities.utils import MAX_LINE_LENGTH, autofill_categories, autofill_groups, format_score_string
+from agon.database.db import engine
+from agon.database.models import Category, CategoryGroup, Score
+from agon.utils import MAX_LINE_LENGTH, autofill_categories, autofill_groups, format_score_string
 
 
 class ViewCog(commands.Cog, name="View Command"):

agon/cogs/commands/views/delete_confirm.py

@@ -4,9 +4,9 @@ import nextcord
 from sqlalchemy import delete, select
 from sqlalchemy.orm import Session
 
-from database.db import engine
-from database.models import Category, CategoryGroup
-from utilities.utils import send_highscore_message
+from agon.database.db import engine
+from agon.database.models import Category, CategoryGroup
+from agon.utils import send_highscore_message
 
 
 class DeleteConfirmView(nextcord.ui.Modal):

agon/cogs/commands/views/update_username_verify.py

@@ -5,9 +5,9 @@ from sqlalchemy import distinct, exc, select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Category, CategoryGroup, Score
-from utilities.utils import send_highscore_message
+from agon.database.db import engine
+from agon.database.models import Category, CategoryGroup, Score
+from agon.utils import send_highscore_message
 
 
 class UpdateUsernameVerifyView(nextcord.ui.View):

agon/cogs/guild_listener/__init__.py

@@ -6,8 +6,8 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Guild
+from agon.database.db import engine
+from agon.database.models import Guild
 
 
 class GuildListener(commands.Cog, name="Guild Listener"):

agon/cogs/loops/guild_data.py

@@ -5,8 +5,8 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Guild
+from agon.database.db import engine
+from agon.database.models import Guild
 
 
 class GuildData(commands.Cog, name="Guild Data"):

agon/cogs/submission/verification_view.py

@@ -5,9 +5,9 @@ from sqlalchemy import delete, select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Submission
-from utilities.utils import submit_score
+from agon.database.db import engine
+from agon.database.models import Submission
+from agon.utils import submit_score
 
 
 class VerificationView(nextcord.ui.View):

agon/database/db.py

@@ -1,8 +1,9 @@
 """Simple file to set up the sqlmodel connection to database."""
 
 from sqlmodel import SQLModel, create_engine
-from utilities import config
-from utilities.logger import agon_logger
+
+from agon import config
+from agon.logger import agon_logger
 
 from . import models  # noqa: F401 - Need this import for creating the models.
 
@@ -10,7 +11,7 @@ if config.ENVIRONMENT == "prod":
     url = f"mysql+pymysql://{config.SQL_USER}:{config.SQL_PASS}@{config.SQL_HOST}/{config.SQL_DB}"
     agon_logger.info("Connected to prod database.")
 else:
-    url = "sqlite:///database.db"
+    url = "sqlite:///database/database.db"
     agon_logger.info("Connected to local dev database.")
 engine = create_engine(url)
 

agon/utils.py

@@ -8,9 +8,9 @@ from sqlalchemy import distinct, select
 from sqlalchemy.orm import Session, aliased
 from sqlmodel import col
 
-from database.db import engine
-from database.models import Category, CategoryGroup, Guild, Score
-from main import agon_logger
+from agon.database.db import engine
+from agon.database.models import Category, CategoryGroup, Guild, Score
+from agon.logger import agon_logger
 
 MAX_LINE_LENGTH = 142
 

database/database_test.py

@@ -1,40 +0,0 @@
-import os
-
-from dotenv import load_dotenv
-from sqlmodel import Session, SQLModel, create_engine, select
-
-from models import CategoryGroup, Guild
-
-load_dotenv()
-
-SQL_DB = os.getenv("SQL_DB", "")
-SQL_HOST = os.getenv("SQL_HOST", "")
-SQL_PASS = os.getenv("SQL_PASS", "")
-SQL_USER = os.getenv("SQL_USER", "")
-
-url = "sqlite:///database.db"
-# url = f"mysql+pymysql://{SQL_USER}:{SQL_PASS}@{SQL_HOST}/{SQL_DB}"
-engine = create_engine(url)
-SQLModel.metadata.create_all(engine)
-
-with Session(engine) as session:
-    guild = Guild(id=1, name="test guild")
-    session.add(guild)
-    group1 = CategoryGroup(name="group1", channel_id=1, guild_id=1, message_id=1)
-    group2 = CategoryGroup(name="group2", channel_id=2, guild_id=1, message_id=2)
-    session.add(group1)
-    session.add(group2)
-    session.commit()
-
-    # anotherone = Guild(id=2, name="test guild 2", submission_channel=1, verification_channel=2)
-    # session.add(anotherone)
-    # group1 = CategoryGroup(name="group1", channel_id=1, guild_id=2, message_id=1)
-    # group2 = CategoryGroup(name="group2", channel_id=2, guild_id=2, message_id=2)
-    # session.add(group1)
-    # session.add(group2)
-    # session.commit()
-
-    stmt = select(Guild).where(Guild.name == "Dakiny")
-    guild = session.scalar(stmt)
-
-    print(guild.category_groups)

database/pyproject.toml

@@ -1,7 +0,0 @@
-[tool.ruff]
-# Extend the `pyproject.toml` file in the parent directory...
-extend = "../pyproject.toml"
-
-[tool.ruff.lint]
-# ignore implicit-namespace-package in this directory.
-ignore = ["INP001"]

highscores_database.sql

@@ -1,56 +0,0 @@
-CREATE DATABASE highscores;
-use highscores;
-
-CREATE TABLE Guilds(
-   GuildId bigint unsigned not null unique,
-   GuildName varchar(95) not null,
-   SubmissionChannel bigint unsigned, -- deprecated, is not used anymore.
-   VerificationChannel bigint unsigned,
-   Active boolean DEFAULT true,
-   PRIMARY KEY (GuildId)
-);
-
-CREATE TABLE CategoryGroups(
-   GroupId int unsigned not null unique AUTO_INCREMENT,
-   GroupName varchar(50) not null,
-   ChannelId bigint unsigned,
-   GuildId bigint unsigned not null,
-   MessageId bigint unsigned,
-   PadLength smallint not null DEFAULT 26,
-   UsernameLength smallint DEFAULT 12,
-   CONSTRAINT UniqueGuildCategoryGroup UNIQUE (GuildId, GroupName),
-   FOREIGN KEY (GuildId) REFERENCES Guilds(GuildId) ON DELETE CASCADE,
-   PRIMARY KEY (GroupId)
-);
-
-CREATE TABLE Categories(
-   CategoryId int unsigned not null unique AUTO_INCREMENT,
-   CategoryName varchar(30) not null,
-   GroupId int unsigned not null,
-   Size smallint not null DEFAULT 3,
-   IsAscending boolean not null DEFAULT true,
-   IsTimeRecord boolean not null DEFAULT false,
-   IsValidated boolean not null DEFAULT true,
-   CONSTRAINT UniqueCategoryInGroup UNIQUE (GroupId, CategoryName),
-   FOREIGN KEY (GroupId) REFERENCES CategoryGroups(GroupId) ON DELETE CASCADE,
-   PRIMARY Key (CategoryId)
-);
-
-CREATE TABLE Scores(
-   UserName varchar(30) not null,
-   Score float not null, -- Maybe should have time and int scores?? timestamp type?
-   CategoryId int unsigned not null,
-   FOREIGN KEY (CategoryId) REFERENCES Categories(CategoryId) ON DELETE CASCADE,
-   PRIMARY KEY (CategoryId, UserName)
-);
-
-CREATE TABLE Submissions(
-   CategoryId int unsigned not null,
-   GroupId int unsigned not null,
-   GuildId bigint unsigned not null,
-   MessageId bigint unsigned not null,
-   Score varchar(30) not null, -- Score is stored as a string until converted during submission
-   UserId bigint unsigned not null,
-   UserName varchar(30) not null,
-   PRIMARY KEY (CategoryId, UserName) -- one submission a category per user.
-);

utilities/__init__.py

@@ -1 +0,0 @@
-"""Package of utility functions and environment configuration variables."""