Rename main.py to app.py, add init and main dunder files.

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

Dockerfile

@@ -1,7 +1,7 @@
 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
 

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,15 @@
 """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)
 
-
-def main() -> None:
+def run() -> None:
     """Main function for bot."""
     min_python_version = (3, 12)
     if sys.version_info < min_python_version:
@@ -34,8 +26,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 +39,3 @@ def main() -> None:
 
     # Run Discord bot
     bot.run(config.DISCORD_TOKEN)
-
-
-if __name__ == "__main__":
-    main()

agon/cogs/commands/submission.py

@@ -3,17 +3,17 @@
 import re
 
 import nextcord
+from cogs.submission.verification_view import VerificationView
+from database.db import engine
+from database.models import Category, CategoryGroup, Guild, Submission
 from nextcord.ext import commands
 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.app import agon_logger
+
 
 class SubmissionCog(commands.Cog):
     """Class holds command for submitting a score."""

agon/utilities/utils.py

@@ -4,13 +4,13 @@ import time
 
 import nextcord
 import pandas as pd
+from database.db import engine
+from database.models import Category, CategoryGroup, Guild, Score
 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.app import agon_logger
 
 MAX_LINE_LENGTH = 142
 

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.
-);