Move sql data classes into database setup directory

Edit docker file to install sqlite3.

.gitea/workflows/build_develop.yml

@@ -0,0 +1,26 @@
+name: build_develop
+
+on:
+  push:
+    branches: [main]
+
+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@v2
+        with:
+          registry: gitea.cheezers.org
+          username: imcompiling
+          password: ${{ secrets.PASSWORD }}
+      - name: Build Docker Image
+        run: docker build -t gitea.cheezers.org/imcompiling/agon:develop .
+      - name: Push Docker Image
+        run: docker push gitea.cheezers.org/imcompiling/agon:develop

.gitea/workflows/build_release.yml

@@ -0,0 +1,30 @@
+name: build_release
+
+on:
+  push:
+    tags: ["v[0-9].[0-9].[0-9]"]
+
+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@v2
+        with:
+          registry: gitea.cheezers.org
+          username: imcompiling
+          password: ${{ secrets.PASSWORD }}
+      - 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
+      - name: Push Tagged Image
+        run: docker push gitea.cheezers.org/imcompiling/agon:${{env.GIT_TAG}}

.gitignore

@@ -105,6 +105,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+poetry.lock
 
 # Spyder project settings
 .spyderproject

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.12.3-slim
+
+RUN apt-get update && apt-get -y upgrade && apt-get -y install sqlite3
+
+WORKDIR /home
+
+
+COPY main.py main.py
+COPY pyproject.toml pyproject.toml
+
+COPY classes classes/
+COPY cogs cogs/
+COPY database_setup database_setup/
+COPY utilities utilities/
+
+RUN pip install --upgrade pip && pip install poetry && poetry export -f requirements.txt --output requirements.txt && pip install -r requirements.txt
+
+CMD ["python3", "./main.py"]

classes/submission.py

@@ -9,7 +9,7 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
-from utilities.sql_data_classes import Category, CategoryGroup, engine
+from database_setup.sql_data_classes import Category, CategoryGroup, engine
 
 
 class SubmissionState(Enum):
@@ -183,11 +183,13 @@ class Submission:
         if state is SubmissionState.CATEGORY:
             description = "Step 1: Choose your category!"
         elif state is SubmissionState.SCORE:
-            description = "Step 2: Input your score!"
+            description = "Step 2: Send a message to input your score!"
         elif state is SubmissionState.PROOF:
-            description = "Step 3: Submit your proof!"
+            description = "Step 3: Send a message with a picture attached to submit your proof!"
         elif state is SubmissionState.NAME:
-            description = "Step 4 (Optional): Change name on submission! (proceed to next if skipping)"
+            description = (
+                "Step 4 (Optional): Send a message to change name on submission! (proceed to next if skipping)"
+            )
         elif state is SubmissionState.SUBMIT:
             description = "Step 5: Submit if everything looks correct!"
         elif state is SubmissionState.VERIFY:

cogs/commands/__init__.py

@@ -6,9 +6,11 @@ from nextcord.ext import commands
 
 from .create import CreateCog
 from .delete import DeleteCog
+from .help import HelpCog
 from .refresh import RefreshCog
 from .set import SetCog
 from .update import UpdateCog
+from .view import ViewCog
 
 
 # This function will be called when this extension is loaded.
@@ -19,6 +21,8 @@ def setup(bot: commands.Bot):
     """
     bot.add_cog(CreateCog(bot))
     bot.add_cog(DeleteCog())
+    bot.add_cog(HelpCog())
     bot.add_cog(RefreshCog(bot))
     bot.add_cog(SetCog())
     bot.add_cog(UpdateCog(bot))
+    bot.add_cog(ViewCog())

cogs/commands/create.py

@@ -2,8 +2,6 @@
 Commands for creating items in bot.
 """
 
-from typing import Optional
-
 import nextcord
 from nextcord.ext import commands
 from sqlalchemy import exc, select
@@ -11,7 +9,7 @@ from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
 from cogs.submission.submission_views import SubmissionCreateButton
-from utilities.sql_data_classes import Category, CategoryGroup, engine
+from database_setup.sql_data_classes import Category, CategoryGroup, engine
 from utilities.utils import MAX_LINE_LENGTH, autofill_groups, send_highscore_message
 
 
@@ -40,7 +38,7 @@ class CreateCog(commands.Cog, name="Create Cog"):
         interaction: nextcord.Interaction,
         group_id: str = nextcord.SlashOption(name="group", description="Group to add Category to.", required=True),
         category_name: str = nextcord.SlashOption(description="Name of new Category.", required=True),
-        is_ascending: bool = nextcord.SlashOption(description="If higher value is better score.", required=True),
+        is_ascending: bool = nextcord.SlashOption(description="If lower value is a better score.", required=True),
         is_time_record: bool = nextcord.SlashOption(
             description="If the score should be shown in time format. Cannot be changed.", required=True
         ),
@@ -64,7 +62,6 @@ class CreateCog(commands.Cog, name="Create Cog"):
             is_validated (bool): If the scores should be validated or not. Is SlashOption.
             size (int): How  many sores to show in the category message. Is SlashOption.
         """
-
         new_category = Category(
             CategoryName=category_name,
             GroupId=int(group_id),
@@ -113,7 +110,7 @@ class CreateCog(commands.Cog, name="Create Cog"):
             min_value=1,
             max_value=30,
         ),
-        channel: Optional[nextcord.abc.GuildChannel] = nextcord.SlashOption(
+        channel: nextcord.abc.GuildChannel | None = nextcord.SlashOption(
             description="Channel to post Group in. If left empty, defaults to current channel.",
             required=False,
             channel_types=[nextcord.ChannelType.text],
@@ -132,7 +129,6 @@ class CreateCog(commands.Cog, name="Create Cog"):
             channel (Optional[nextcord.abc.GuildChannel]): Channel to post group in. If None, defaults to current
                 channel. Is SlashOption.
         """
-
         # if no channel provided, use current channel.
         if channel is None:
             channel = interaction.channel
@@ -168,5 +164,4 @@ class CreateCog(commands.Cog, name="Create Cog"):
             interaction (nextcord.Interaction): Interaction with command.
             group_id (str): String to run autocomplete compared to.
         """
-
         await interaction.response.send_autocomplete(autofill_groups(interaction.guild_id, group_id))

cogs/commands/delete.py

@@ -2,15 +2,13 @@
 Commands for deleting groups/categories/scores in database and messages in discord..
 """
 
-from typing import Optional
-
 import nextcord
 from nextcord.ext import commands
 from sqlalchemy import distinct, select
 from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
-from utilities.sql_data_classes import Category, CategoryGroup, Score, engine
+from database_setup.sql_data_classes import Category, CategoryGroup, Score, engine
 from utilities.utils import (
     autofill_categories,
     autofill_groups,
@@ -48,7 +46,7 @@ class DeleteCog(commands.Cog, name="Table Management"):
     async def channel_messages(
         self,
         interaction: nextcord.Interaction,
-        channel: Optional[nextcord.abc.GuildChannel] = nextcord.SlashOption(
+        channel: nextcord.abc.GuildChannel | None = nextcord.SlashOption(
             description="Channel to clear of messages.",
             required=False,
             channel_types=[nextcord.ChannelType.text],
@@ -64,7 +62,6 @@ class DeleteCog(commands.Cog, name="Table Management"):
             channel (Optional[nextcord.abc.GuildChannel]): Channel to clear of messages.
                 Is a SlashOption. Limited to text channels. Defaults to None.
         """
-
         if not channel:
             channel = interaction.channel
 
@@ -107,10 +104,9 @@ class DeleteCog(commands.Cog, name="Table Management"):
             interaction (nextcord.Interaction): Interaction that invoked the command.
             user_name (str): User to remove from highscores
         """
-
         with Session(engine) as session:
             stmt = select(distinct(Score.CategoryId)).where(Score.UserName == user_name)
-            category_ids: "list[int]" = list(session.scalars(stmt))
+            category_ids: list[int] = list(session.scalars(stmt))
 
             stmt = select(Score).where(Score.UserName == user_name)
             for score in session.scalars(stmt):
@@ -185,7 +181,6 @@ class DeleteCog(commands.Cog, name="Table Management"):
             category_id (str): String representation of Category id to remove user from. Is SlashOption.
             user_name (str): The user to remove. Is SlashOption.
         """
-
         with Session(engine) as session:
             stmt = select(CategoryGroup).where(CategoryGroup.GroupId == int(group_id))
             group = session.scalar(stmt)
@@ -219,7 +214,6 @@ class DeleteCog(commands.Cog, name="Table Management"):
             group_id (str): String representation of Group id to remove user from. Is SlashOption.
             user_name (str): The user to remove. Is SlashOption.
         """
-
         with Session(engine) as session:
             stmt = select(CategoryGroup).where(CategoryGroup.GroupId == int(group_id))
             group = session.scalar(stmt)
@@ -267,7 +261,7 @@ class DeleteCog(commands.Cog, name="Table Management"):
     @from_category.on_autocomplete("user_name")
     @from_group.on_autocomplete("user_name")
     async def user_autocomplete(
-        self, interaction: nextcord.Interaction, user_name: str, group_id: str, category_id: Optional[str] = None
+        self, interaction: nextcord.Interaction, user_name: str, group_id: str, category_id: str | None = None
     ):
         """
         Autocomplete functions for user names.
@@ -278,7 +272,6 @@ class DeleteCog(commands.Cog, name="Table Management"):
             group_id (str): String representation of Group id to find category from.
             category_id (Optional[str]): String representation of Category id to find User from, can be None.
         """
-
         await interaction.response.send_autocomplete(
             autofill_users_in_group_category(
                 interaction.guild_id, int(group_id), category_id if category_id else 0, user_name

cogs/commands/help.py

@@ -0,0 +1,45 @@
+"""
+Commands for helping a user.
+"""
+
+import nextcord
+from nextcord.ext import commands
+
+
+class HelpCog(commands.Cog, name="Help commands."):
+    """
+    Class holds commands for getting help.
+    """
+
+    def __init__(self) -> None:
+        """
+        Default constructor for HelpCog class. Does nothing.
+        """
+
+    @nextcord.slash_command()
+    async def help(self, interaction: nextcord.Interaction):
+        """
+        Parent slash command for help. Never called.
+        """
+
+    @help.subcommand(description="Describes how to get started with Agon.")
+    async def setup(self, interaction: nextcord.Interaction):
+        """
+        Sends a message describing how to get started with Agon.
+
+        Args:
+            interaction (nextcord.Interaction): Interaction that invoked the command.
+        """
+        # I hate this but don't want indents in the string.
+        # pylint: disable=line-too-long
+        help_str: str = """Welcome to Agon! Three simple steps are needed to get started.
+1.) Set a channel to recieve submission verifications with "/set verify_channel."
+This channel is used to allow moderators to check if a submission is real/valid.
+
+2.) Set a channel for submissions to be posted in with "/set submission_channel."
+This channel will be where all user submission messages are sent.
+
+3.) Set up your highscore tables! Use "/create group" to first create a group message in the channel you would like and then use "/create category" to create a category in that group message!"""
+        # pylint: enable=line-too-long
+
+        await interaction.response.send_message(content=help_str)

cogs/commands/refresh.py

@@ -9,7 +9,7 @@ from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
 from cogs.submission.submission_views import SubmissionCreateButton
-from utilities.sql_data_classes import CategoryGroup, engine
+from database_setup.sql_data_classes import CategoryGroup, engine
 from utilities.utils import autofill_groups, send_highscore_message
 
 
@@ -46,7 +46,6 @@ class RefreshCog(commands.Cog, name="Refresh Cog"):
             interaction (nextcord.Interaction): Interaction that invoked the command.
             group_id (str): Str representation of Group id to refresh. Is SlashOption.
         """
-
         with Session(engine) as session:
             stmt = (
                 select(CategoryGroup)
@@ -78,7 +77,6 @@ class RefreshCog(commands.Cog, name="Refresh Cog"):
         Args:
             interaction (nextcord.Interaction): Interaction that invoked the command.
         """
-
         with Session(engine) as session:
             stmt = select(CategoryGroup).where(CategoryGroup.GuildId == interaction.guild_id)
 
@@ -100,5 +98,4 @@ class RefreshCog(commands.Cog, name="Refresh Cog"):
             interaction (nextcord.Interaction): Interaction with command.
             group_id (str): String to run autocomplete compared to.
         """
-
         await interaction.response.send_autocomplete(autofill_groups(interaction.guild_id, group_id))

cogs/commands/set.py

@@ -2,15 +2,13 @@
 Set command heirarchy.
 """
 
-from typing import Optional
-
 import nextcord
 from nextcord.ext import commands
 from sqlalchemy import select
 from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
-from utilities.sql_data_classes import CategoryGroup, Guild, engine
+from database_setup.sql_data_classes import CategoryGroup, Guild, engine
 from utilities.utils import MAX_LINE_LENGTH, autofill_groups
 
 
@@ -37,7 +35,7 @@ class SetCog(commands.Cog, name="Set command."):
         group_id: str = nextcord.SlashOption(
             name="group", description="Category Group to assign to channel.", required=True
         ),
-        channel: Optional[nextcord.abc.GuildChannel] = nextcord.SlashOption(
+        channel: nextcord.abc.GuildChannel | None = nextcord.SlashOption(
             description="Channel to register",
             required=False,
             channel_types=[nextcord.ChannelType.text],
@@ -48,12 +46,11 @@ class SetCog(commands.Cog, name="Set command."):
         Command function to register a CategoryGroup's output channel.
 
         Args:
-            interaction (nextcord.Interaction): Interaction that invoked the command
+            interaction (nextcord.Interaction): Interaction that invoked the command.
             group_id (str): String representation of Group id to register channel to. Is SlashOption.
             channel (nextcord.abc.GuildChannel, optional): Channel to register
                 Is a SlashOption. Limited to text channels, Defaults to None.
         """
-
         if not channel:
             channel = interaction.channel
         channel_id = channel.id
@@ -93,7 +90,6 @@ class SetCog(commands.Cog, name="Set command."):
             group_id (str): String representation of Group id to set pad length in. Is SlashOption.
             length (int): Number of characters. Is SlashOption. Defaults to 26.
         """
-
         with Session(engine) as session:
             stmt = (
                 select(CategoryGroup)
@@ -111,7 +107,7 @@ class SetCog(commands.Cog, name="Set command."):
     async def submission_channel(
         self,
         interaction: nextcord.Interaction,
-        channel: Optional[nextcord.abc.GuildChannel] = nextcord.SlashOption(
+        channel: nextcord.abc.GuildChannel | None = nextcord.SlashOption(
             description="Channel to register",
             required=False,
             channel_types=[nextcord.ChannelType.text],
@@ -126,7 +122,6 @@ class SetCog(commands.Cog, name="Set command."):
             channel Optional[nextcord.abc.GuildChannel], optional): Channel to register
                 Is a SlashOption. Limited to text channels, Defaults to None.
         """
-
         if not channel:
             channel = interaction.channel
 
@@ -156,7 +151,6 @@ class SetCog(commands.Cog, name="Set command."):
             interaction (nextcord.Interaction): Interaction that invoked the command
             length (int): Number of characters. Is SlashOption. Defaults to 12.
         """
-
         with Session(engine) as session:
             stmt = (
                 select(CategoryGroup)
@@ -172,7 +166,7 @@ class SetCog(commands.Cog, name="Set command."):
     async def verify_channel(
         self,
         interaction: nextcord.Interaction,
-        channel: Optional[nextcord.abc.GuildChannel] = nextcord.SlashOption(
+        channel: nextcord.abc.GuildChannel | None = nextcord.SlashOption(
             description="Channel to register",
             required=False,
             channel_types=[nextcord.ChannelType.text],
@@ -187,7 +181,6 @@ class SetCog(commands.Cog, name="Set command."):
             channel (Optional[nextcord.abc.GuildChannel]): Channel to register
                 Is a SlashOption. Limited to text channels, Defaults to None.
         """
-
         if not channel:
             channel = interaction.channel
         channel_id = channel.id

cogs/commands/update.py

@@ -8,7 +8,7 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
-from utilities.sql_data_classes import Guild, engine
+from database_setup.sql_data_classes import Guild, engine
 from utilities.utils import autofill_users_in_guild
 
 from .views.update_username_verify import UpdateUsernameVerifyView
@@ -57,7 +57,6 @@ class UpdateCog(commands.Cog, name="Update commands."):
             old_username (str): Username to replace.
             new_username (str): Username to replace old with.
         """
-
         with Session(engine) as session:
             stmt = select(Guild.VerificationChannel).where(Guild.GuildId == interaction.guild_id)
             verify_channel = interaction.guild.get_channel(session.scalar(stmt))

cogs/commands/view.py

@@ -0,0 +1,112 @@
+"""
+View command heirarchy.
+"""
+
+import nextcord
+import pandas as pd
+from nextcord.ext import commands
+from sqlalchemy import select
+from sqlalchemy.orm import Session
+
+# pylint: disable=import-error
+from database_setup.sql_data_classes import Category, CategoryGroup, Score, engine
+from utilities.utils import MAX_LINE_LENGTH, autofill_categories, autofill_groups, format_score_string
+
+
+class ViewCog(commands.Cog, name="View Command"):
+    """
+    Class holds commands for viewing data.
+    """
+
+    def __init__(self) -> None:
+        """
+        Default constructor for ViewCog class. Does nothing.
+        """
+
+    @nextcord.slash_command()
+    async def view(self, interaction: nextcord.Interaction):
+        """
+        Parent slash command for view. Never called.
+        """
+
+    @view.subcommand(description="Lists all scores for a given category.")
+    async def leaderboard(
+        self,
+        interaction: nextcord.Interaction,
+        group_id: str = nextcord.SlashOption(
+            name="group", description="Group to show leaderboard from.", required=True
+        ),
+        category_id: str = nextcord.SlashOption(
+            name="category", description="Category to show leaderboard.", required=True
+        ),
+    ):
+        """
+        Gathers all users that have a submission in the group/category combo and returns a message with them
+        in ranked order.
+
+        Args:
+            interaction (nextcord.Interaction): Interaction that invoked the command.
+            group_id (str): String representation of Group id to search from. Is SlashOption.
+            category_id (str): String representation of Category id to show leaderboard. Is SlashOption.
+        """
+        str_list: list[str] = []
+
+        # get group, category, and all scores sorted correctly.
+        with Session(engine) as session:
+            stmt = select(CategoryGroup).where(CategoryGroup.GroupId == int(group_id))
+            group = session.scalar(stmt)
+
+            stmt = select(Category).where(Category.CategoryId == int(category_id))
+            category = session.scalar(stmt)
+
+            d_f = pd.read_sql_query(
+                sql=session.query(Score).where(Score.CategoryId == category_id).statement, con=engine
+            )
+
+        scores = d_f.sort_values("Score", ascending=category.IsAscending).reset_index()
+
+        # get the longest string
+        longest_str: int = scores.UserName.map(len).max()
+
+        for i, row in scores.iterrows():
+            str_list.append(
+                format_score_string(
+                    row["UserName"], row["Score"], longest_str, category.IsTimeRecord, i + 1, MAX_LINE_LENGTH
+                )
+            )
+
+        message_str: str = f"**{group.GroupName} {category.CategoryName} Leaderboard!**\n```"
+        if len(str_list) == 0:
+            message_str += "No Submissions!"
+        else:
+            for line in str_list:
+                message_str += f"{line}\n"
+
+        message_str += "```"
+
+        await interaction.response.send_message(content=message_str)
+
+    @leaderboard.on_autocomplete("group_id")
+    async def group_autocomplete(self, interaction: nextcord.Interaction, group_id: str):
+        """
+        Autocomplete function for table names.
+
+        Args:
+            interaction (nextcord.Interaction): Interaction that invoked the command.
+            group_id (str): String to be autocompleted with Group name.
+        """
+        await interaction.response.send_autocomplete(autofill_groups(interaction.guild_id, group_id))
+
+    @leaderboard.on_autocomplete("category_id")
+    async def category_autocomplete(self, interaction: nextcord.Interaction, category_id: str, group_id: str):
+        """
+        Autocomplete function for category names.
+
+        Args:
+            interaction (nextcord.Interaction): Interaction that invoked the command.
+            category_id (str): String to be autocompleted with Category name.
+            group_id (str): Group to find Category from.
+        """
+        await interaction.response.send_autocomplete(
+            autofill_categories(interaction.guild_id, int(group_id), category_id)
+        )

cogs/commands/views/delete_confirm.py

@@ -2,14 +2,12 @@
 Contains view and helper functions for confirming and processing deletes.
 """
 
-from typing import Optional
-
 import nextcord
 from sqlalchemy import delete, select
 from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
-from utilities.sql_data_classes import Category, CategoryGroup, engine
+from database_setup.sql_data_classes import Category, CategoryGroup, engine
 from utilities.utils import send_highscore_message
 
 
@@ -61,7 +59,7 @@ class DeleteConfirmView(nextcord.ui.Modal):
         await interaction.response.send_message("Deletion complete.", ephemeral=True)
 
 
-def create_delete_id(group_id: int, category_id: Optional[int] = None) -> str:
+def create_delete_id(group_id: int, category_id: int | None = None) -> str:
     """
     Creates a delete id string to tell the view what to delete.
 

cogs/commands/views/update_username_verify.py

@@ -5,7 +5,7 @@ from sqlalchemy import distinct, exc, select
 from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
-from utilities.sql_data_classes import Category, CategoryGroup, Score, engine
+from database_setup.sql_data_classes import Category, CategoryGroup, Score, engine
 from utilities.utils import send_highscore_message
 
 
@@ -19,9 +19,7 @@ class UpdateUsernameVerifyView(nextcord.ui.View):
         super().__init__(timeout=None)
 
     @nextcord.ui.button(label="Deny", style=nextcord.ButtonStyle.red, custom_id="deny-username-update")
-    async def deny_button(
-        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
-    ):  # pylint: disable=unused-argument
+    async def deny_button(self, button: nextcord.ui.Button, interaction: nextcord.Interaction):  # pylint: disable=unused-argument
         """
         Button for denying username update. Deletes message.
 
@@ -32,9 +30,7 @@ class UpdateUsernameVerifyView(nextcord.ui.View):
         await interaction.message.delete()
 
     @nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green, custom_id="approve-username-update")
-    async def approve_button(
-        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
-    ):  # pylint: disable=unused-argument
+    async def approve_button(self, button: nextcord.ui.Button, interaction: nextcord.Interaction):  # pylint: disable=unused-argument
         """
         Button for approving username update. Tells guild data to update username, then updates
         message to show it is complete.
@@ -43,7 +39,6 @@ class UpdateUsernameVerifyView(nextcord.ui.View):
             button (nextcord.ui.Button): unused
             interaction (nextcord.Interaction): Interaction with the button
         """
-
         with Session(engine) as session:
             try:
                 embed_content = interaction.message.embeds[0].to_dict()
@@ -51,7 +46,7 @@ class UpdateUsernameVerifyView(nextcord.ui.View):
                 new_username: str = embed_content["fields"][1]["value"]
 
                 stmt = select(distinct(Score.CategoryId)).where(Score.UserName == old_username)
-                category_ids: "list[int]" = list(session.scalars(stmt))
+                category_ids: list[int] = list(session.scalars(stmt))
 
                 stmt = select(Score).where(Score.UserName == old_username)
                 for score in session.scalars(stmt):

cogs/guild_listener/__init__.py

@@ -4,11 +4,11 @@ Defines cog for guild listeners. Contains functions for various guild events.
 
 import nextcord
 from nextcord.ext import commands
+from sqlalchemy import select
 from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
-from utilities.sql_data_classes import Guild, engine
-from utilities.utils import add_preset_configuration
+from database_setup.sql_data_classes import Guild, engine
 
 
 class GuildListener(commands.Cog, name="Guild Listener"):
@@ -19,14 +19,50 @@ class GuildListener(commands.Cog, name="Guild Listener"):
 
     @commands.Cog.listener()
     async def on_guild_join(self, guild: nextcord.Guild):
-        """Listener for Guild Join. Adds guild to database."""
-
-        new_guild = Guild(GuildId=guild.id)
+        """
+        Listener for Guild Join. Adds guild to database.
 
+        Args:
+            guild (nextcord.Guild): Guild that was joined.
+        """
         with Session(engine) as session:
-            session.add(new_guild)
+            stmt = select(Guild).where(Guild.GuildId == guild.id)
+            guild_data = session.scalar(stmt)
+
+            # just in case check if the guild already exists
+            if guild_data is None:
+                new_guild = Guild(GuildId=guild.id, GuildName=guild.name)
+                session.add(new_guild)
+            else:
+                guild_data.GuildName = guild.name
+                guild_data.Active = True
+
             session.commit()
 
+        # let imcompiling#2272 know about a new server joining!
+        # staying with fetch due to intents not being set up correctly. Maybe change to get eventually.
+        imcompiling: nextcord.User = await self.bot.fetch_user(206602713511886849)
+        await imcompiling.send(f'Agon has joined server "{guild.name}"!')
+
+    @commands.Cog.listener()
+    async def on_guild_remove(self, guild: nextcord.Guild):
+        """
+        Listens to when the bot has been removed from a guild. Update's the database to record the active flag as false.
+
+        Args:
+            guild (nextcord.Guild): Guild that was left.
+        """
+        with Session(engine) as session:
+            stmt = select(Guild).where(Guild.GuildId == guild.id)
+            guild_data = session.scalar(stmt)
+            guild_data.Active = False
+            session.commit()
+
+        # let imcompiling#2272 know about leaving a server.
+        # staying with fetch due to intents not being set up correctly. Maybe change to get eventually.
+        imcompiling: nextcord.User = await self.bot.fetch_user(206602713511886849)
+        await imcompiling.send(f'Agon has been removed from "{guild.name}".')
+
 
 # This function will be called when this extension is loaded.
 # It is necessary to add these functions to the bot.

cogs/loops/__init__.py

@@ -0,0 +1,16 @@
+"""
+Initializing code for all loops.
+"""
+
+from nextcord.ext import commands
+
+from .bot_presence import BotPresence
+from .guild_data import GuildData
+
+
+# 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):
+    """Adds function to bot"""
+    bot.add_cog(BotPresence(bot))
+    bot.add_cog(GuildData(bot))

cogs/loops/bot_presence.py

@@ -1,5 +1,5 @@
 """
-Functions for controlling the bot's presence.
+Functions for controlling the bot's presence. Also contains the loop.
 """
 
 import random
@@ -46,10 +46,3 @@ class BotPresence(commands.Cog, name="Bot Presence"):
         status += f" | {len(self.bot.guilds)} servers"
 
         await self.bot.change_presence(activity=nextcord.Game(status))
-
-
-# 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):
-    """Adds function to bot"""
-    bot.add_cog(BotPresence(bot))

cogs/loops/guild_data.py

@@ -0,0 +1,48 @@
+"""
+Contains a loop that updates guild data in the database periodically.
+"""
+
+from nextcord.ext import commands, tasks
+from sqlalchemy import select
+from sqlalchemy.orm import Session
+
+# pylint: disable=import-error
+from database_setup.sql_data_classes import Guild, engine
+
+
+class GuildData(commands.Cog, name="Guild Data"):
+    """Class to contain loop."""
+
+    def __init__(self, bot: commands.bot) -> None:
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        """Starts the loop when bot is ready."""
+        await self.bot.wait_until_ready()
+        # pylint doesn't recognize that periodic_update_guild_data is subclassed from tasks.loop.
+        await self.periodic_update_guild_data.start()  # pylint: disable=no-member
+
+    @tasks.loop(hours=24)
+    async def periodic_update_guild_data(self):
+        """Loops every day, calls update_guild_data."""
+        self.update_guild_data()
+
+    def update_guild_data(self):
+        """
+        Updates all known guild's data in the database.
+        """
+        with Session(engine) as session:
+            for guild in self.bot.guilds:
+                # update given guild name for guild id
+                stmt = select(Guild).where(Guild.GuildId == guild.id)
+                guild_data = session.scalar(stmt)
+
+                # just in case checking if the guild doesn't exist.
+                if guild_data is None:
+                    new_guild = Guild(GuildId=guild.id, GuildName=guild.name)
+                    session.add(new_guild)
+                else:
+                    guild_data.GuildName = guild.name
+
+                session.commit()

cogs/message_listener/__init__.py

@@ -3,6 +3,7 @@ Defines cog for on message listener.
 """
 
 import re
+from datetime import datetime
 
 import nextcord
 from nextcord.ext import commands
@@ -11,8 +12,8 @@ from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
 from classes.submission import SubmissionState
-from highscores import submission_objects
-from utilities.sql_data_classes import Category, Guild, engine
+from main import submission_objects
+from database_setup.sql_data_classes import Category, Guild, engine
 
 
 class SubmissionListener(commands.Cog, name="Message Listener"):
@@ -28,6 +29,8 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
         if message.author.id == self.bot.user.id:
             return
 
+        await birthday_action(message)
+
         guild_id = message.guild.id
 
         if submission_objects.has_user(message.author.id):
@@ -45,7 +48,6 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
                 if message.channel.id == submission_channel_id:
                     state = submission.submission_state
                     if state == SubmissionState.SCORE and message.content:
-
                         stmt = select(Category.IsTimeRecord).where(Category.CategoryId == submission.category_id)
 
                         # check with regex if score matches correctly
@@ -102,3 +104,18 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
 def setup(bot: commands.Bot):
     """Adds function to bot"""
     bot.add_cog(SubmissionListener(bot))
+
+
+async def birthday_action(message: nextcord.Message) -> None:
+    """
+    Does the birthday thing, currently for chris only.
+
+    Args:
+        message (nextcord.Message): The message to check for birthday thing.
+    """
+    today = datetime.today()
+    birthday = datetime(today.year, 7, 31)
+    chris = 642330132958281750
+    if today.date() == birthday.date():
+        if message.author.id == chris or chris in message.raw_mentions:
+            await message.add_reaction("🎂")

cogs/submission/submission_views.py

@@ -1,7 +1,5 @@
 """Views used for submission process."""
 
-from typing import Optional
-
 import nextcord
 from nextcord.ext import commands
 from sqlalchemy import select
@@ -9,15 +7,15 @@ from sqlalchemy.orm import Session, aliased
 
 # pylint: disable=import-error
 from classes.submission import Submission, SubmissionState
-from highscores import submission_objects
-from utilities.sql_data_classes import Category, CategoryGroup, Guild, engine
+from main import submission_objects
+from database_setup.sql_data_classes import Category, CategoryGroup, Guild, engine
 
 from .verification_view import VerificationView
 
 
 def category_select_options(group_id: int) -> "list[nextcord.SelectOption]":
     """Returns list of categories for a given boss."""
-    options: "list[nextcord.SelectOption]" = []
+    options: list[nextcord.SelectOption] = []
 
     with Session(engine) as session:
         subq = select(CategoryGroup).where(CategoryGroup.GroupId == group_id).subquery()
@@ -147,11 +145,8 @@ class SubmissionCreateButton(nextcord.ui.View):
         self._bot = bot
 
     @nextcord.ui.button(label="Submit", style=nextcord.ButtonStyle.primary, custom_id="submitcreate")
-    async def submitcreate_button(
-        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
-    ):  # pylint: disable=unused-argument
+    async def submitcreate_button(self, button: nextcord.ui.Button, interaction: nextcord.Interaction):  # pylint: disable=unused-argument
         """Button for score submission."""
-
         # Don't allow a user to start a new submission if one already exists
         if submission_objects.has_user(interaction.user.id):
             await interaction.send("Please finish in progress submission first.", ephemeral=True)
@@ -198,7 +193,7 @@ class SubmissionView(nextcord.ui.View):
         bot: commands.Bot,
         submission_user: int,
         *,
-        timeout: Optional[float] = 300,
+        timeout: float | None = 300,
     ):
         super().__init__(timeout=timeout)
         self._submission_user = submission_user
@@ -231,6 +226,6 @@ class SubmissionView(nextcord.ui.View):
 
         return check
 
-    async def on_timeout(self) -> None:
-        # remove user from submission objects after time out. Allows user to start new submission.
-        submission_objects.remove_user_submission(self._submission_user)
+    # async def on_timeout(self) -> None:
+    #     # remove user from submission objects after time out. Allows user to start new submission.
+    #     submission_objects.remove_user_submission(self._submission_user)

cogs/submission/verification_view.py

@@ -13,16 +13,12 @@ class VerificationView(nextcord.ui.View):
         super().__init__(timeout=None)
 
     @nextcord.ui.button(label="Deny", style=nextcord.ButtonStyle.red, custom_id="deny-button-submission")
-    async def deny_button(
-        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
-    ):  # pylint: disable=unused-argument
+    async def deny_button(self, button: nextcord.ui.Button, interaction: nextcord.Interaction):  # pylint: disable=unused-argument
         """Button for denying score submission."""
         await interaction.message.delete()
 
     @nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green, custom_id="approve-button-submission")
-    async def approve_button(
-        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
-    ):  # pylint: disable=unused-argument
+    async def approve_button(self, button: nextcord.ui.Button, interaction: nextcord.Interaction):  # pylint: disable=unused-argument
         """Button for approving score submission."""
         for embed in interaction.message.embeds:
             content = embed.to_dict()
@@ -38,7 +34,6 @@ class VerificationView(nextcord.ui.View):
                     user = field["value"]
 
         try:
-
             await submit_score(interaction, group_id, category_id, user, score)
             content = interaction.message.content
             content += f"\nApproved by <@{interaction.user.id}>."

database_setup/create_database.py

@@ -0,0 +1,13 @@
+"""Small script to create the database if it doesn't already exist."""
+
+import sqlite3
+from pathlib import Path
+
+if not Path("database/dakiny.db").exists():
+    with sqlite3.connect("database/dakiny.db") as con:
+        cur = con.cursor()
+
+        with Path("database_setup/database.sql", encoding="utf-8").open() as file:
+            database_script = file.read()
+            cur.executescript(database_script)
+            con.commit()

database_setup/pyproject.toml

@@ -0,0 +1,7 @@
+[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"]

database_setup/sql_data_classes.py

@@ -1,14 +1,11 @@
-"""
-Simple file to set up the sqlalchemy connection to database.
-"""
+"""Simple file to set up the sqlalchemy connection to database."""
+
 from sqlalchemy import create_engine
 from sqlalchemy.ext.automap import automap_base
-
-# pylint: disable=import-error
 from utilities import config
 
 # connect with sql alchemy and autoload schema
-url = f"mysql://{config.SQL_USER}:{config.SQL_PASS}@{config.SQL_HOST}/{config.SQL_DB}"
+url = f"mysql+pymysql://{config.SQL_USER}:{config.SQL_PASS}@{config.SQL_HOST}/{config.SQL_DB}"
 engine = create_engine(url)
 Base = automap_base()
 Base.prepare(autoload_with=engine)

docker-compose.yml

@@ -1,16 +0,0 @@
-version: "3"
-services:
-  sqldb:
-    restart: unless-stopped
-    image: "highscores_db"
-    container_name: "Highscores-DataBase"
-    volumes:
-      - highscores_data:/var/lib/mysql
-    ports:
-      - 3306:3306
-    environment:
-      - MYSQL_ROOT_PASSWORD=${SQL_PASS}
-      - MYSQL_ROOT_USERNAME=${SQL_USER}
-
-volumes:
-  highscores_data:

docker/MySql/Dockerfile

@@ -1,3 +0,0 @@
-FROM mysql:latest
-
-COPY highscores_database.sql /docker-entrypoint-initdb.d/

highscores_database.sql

@@ -3,8 +3,10 @@ use highscores;
 
 CREATE TABLE Guilds(
    GuildId bigint unsigned not null unique,
+   GuildName varchar(95) not null,
    SubmissionChannel bigint unsigned,
    VerificationChannel bigint unsigned,
+   Active boolean DEFAULT true,
    PRIMARY KEY (GuildId)
 );
 
@@ -17,7 +19,7 @@ CREATE TABLE CategoryGroups(
    PadLength smallint not null DEFAULT 26,
    UsernameLength smallint DEFAULT 12,
    CONSTRAINT UniqueGuildCategoryGroup UNIQUE (GuildId, GroupName),
-   FOREIGN KEY (GuildId) REFERENCES Guilds(GuildId),
+   FOREIGN KEY (GuildId) REFERENCES Guilds(GuildId) ON DELETE CASCADE,
    PRIMARY KEY (GroupId)
 );
 
@@ -30,7 +32,7 @@ CREATE TABLE Categories(
    IsTimeRecord boolean not null DEFAULT false,
    IsValidated boolean not null DEFAULT true,
    CONSTRAINT UniqueCategoryInGroup UNIQUE (GroupId, CategoryName),
-   FOREIGN KEY (GroupId) REFERENCES CategoryGroups(GroupId),
+   FOREIGN KEY (GroupId) REFERENCES CategoryGroups(GroupId) ON DELETE CASCADE,
    PRIMARY Key (CategoryId)
 );
 
@@ -38,6 +40,6 @@ 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),
+   FOREIGN KEY (CategoryId) REFERENCES Categories(CategoryId) ON DELETE CASCADE,
    PRIMARY KEY (CategoryId, UserName)
 );

main.py

@@ -9,9 +9,10 @@ import sys
 import nextcord
 from nextcord.ext import commands
 
+from classes.submission import SubmissionMap
+
 # pylint: disable=import-error
 from utilities import config
-from classes.submission import SubmissionMap
 
 logger = logging.getLogger("nextcord")
 logger.setLevel(logging.DEBUG)
@@ -29,7 +30,7 @@ def main():
         print("ERROR: Python version must be >= 3.8")
         sys.exit()
 
-    # Allows privledged intents for monitoring members joining, roles editing, and role assignments
+    # 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()
 

pyproject.toml

@@ -0,0 +1,131 @@
+[tool.poetry]
+name = "agon"
+version = "0.1.0"
+description = "A highscores discord bot"
+authors = ["imcompiling <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+nextcord = "^2.6.0"
+python-dotenv = "^1.0.1"
+pandas = "^2.2.3"
+sqlalchemy = "^2.0.35"
+pymysql = "^1.1.1"
+cryptography = "^43.0.1"
+setuptools = "^75.1.0"
+
+
+[tool.poetry.group.dev.dependencies]
+ruff = "^0.6.9"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+    "dakiny-messages",    # Don't need to lint this git repo.
+]
+
+# Same as Black.
+line-length = 120
+indent-width = 4
+
+# Assume Python 3.8
+target-version = "py312"
+
+[tool.ruff.lint]
+# 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 = ["ALL"]
+ignore = [
+    "ANN101",
+    "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"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.flake8-annotations]
+mypy-init-return = true
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = true
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"

requirements.txt

@@ -1,5 +0,0 @@
-nextcord>=2.3.2
-python-dotenv>=0.20.0
-pandas>=1.5.2
-sqlalchemy>=1.4.44
-mysqlclient>-2.1.1

utilities/utils.py

@@ -11,7 +11,7 @@ from sqlalchemy import distinct, select
 from sqlalchemy.orm import Session, aliased
 
 # pylint: disable=import-error
-from utilities.sql_data_classes import Category, CategoryGroup, Guild, Score, engine
+from database_setup.sql_data_classes import Category, CategoryGroup, Guild, Score, engine
 
 MAX_LINE_LENGTH = 142
 
@@ -29,7 +29,6 @@ def autofill_categories(guild_id: int, group_id: int, category_begin: str) -> "d
     Returns:
         dict[str, str]: List of all category names that start with category_begin.
     """
-
     with Session(engine) as session:
         # search database for all category names
         subq = (
@@ -40,18 +39,18 @@ def autofill_categories(guild_id: int, group_id: int, category_begin: str) -> "d
         )
         cat_group_alias = aliased(CategoryGroup, subq)
         stmt = select(Category).where(Category.GroupId == cat_group_alias.GroupId)
-        categories_dict: dict = {cat.CategoryName: str(cat.CategoryId) for cat in session.scalars(stmt)}
+        categories_dict: dict[str, str] = {cat.CategoryName: str(cat.CategoryId) for cat in session.scalars(stmt)}
 
     # if string empty, return all category names
     if not category_begin:
-        return categories_dict
+        return dict(list(categories_dict.items())[:25])
 
     # else find all categories that start with category_begin
     # TODO is it better to have sql handle the starts with or python?
-    categories: dict = {
+    categories: dict[str, str] = {
         cat_name: cat_id for cat_name, cat_id in categories_dict.items() if category_begin.lower() in cat_name.lower()
     }
-    return categories
+    return dict(list(categories.items())[:25])
 
 
 def autofill_groups(guild_id: int, group_begin: str) -> "dict[str, str]":
@@ -65,24 +64,23 @@ def autofill_groups(guild_id: int, group_begin: str) -> "dict[str, str]":
     Returns:
         dict[str, str]: Dict of group names and ids where group name start with group_begin. Key is name, value is id.
     """
-
     with Session(engine) as session:
         # Select all groups in guild.
         stmt = select(CategoryGroup).where(CategoryGroup.GuildId == guild_id)
 
         # dict has to have key values of same type for discord.
-        group_dict: dict = {group.GroupName: str(group.GroupId) for group in session.scalars(stmt)}
+        group_dict: dict[str, str] = {group.GroupName: str(group.GroupId) for group in session.scalars(stmt)}
 
     # if string empty, return all group names
     if not group_begin:
-        return group_dict
+        return dict(list(group_dict.items())[:25])
 
     # else find all groups that start with group_begin
-    groups: dict = {
+    groups: dict[str, str] = {
         group_name: group_id for group_name, group_id in group_dict.items() if group_begin.lower() in group_name.lower()
     }
 
-    return groups
+    return dict(list(groups.items())[:25])
 
 
 def autofill_users_in_group_category(guild_id: int, group_id: int, category_id: int, user_begin: str) -> "list[str]":
@@ -99,7 +97,6 @@ def autofill_users_in_group_category(guild_id: int, group_id: int, category_id:
     Returns:
         list[str]: List of users that start with user_begin.
     """
-
     with Session(engine) as session:
         # get all categories in the group
         subq = (
@@ -126,16 +123,16 @@ def autofill_users_in_group_category(guild_id: int, group_id: int, category_id:
             category = aliased(Category, subq)
             stmt = select(distinct(Score.UserName)).where(Score.CategoryId == category.CategoryId)
 
-        users_list: "list[str]" = list(session.scalars(stmt))
+        users_list: list[str] = list(session.scalars(stmt))
 
     # if string empty, return all users
     if not user_begin:
-        return users_list
+        return users_list[:25]
 
     # else find all users that start with user_begin
-    users = [user for user in users_list if user_begin.lower() in user.lower()]
+    users: list[str] = [user for user in users_list if user_begin.lower() in user.lower()]
 
-    return users
+    return users[:25]
 
 
 def autofill_users_in_guild(guild_id: int, user_begin: str) -> "list[str]":
@@ -149,21 +146,20 @@ def autofill_users_in_guild(guild_id: int, user_begin: str) -> "list[str]":
     Returns:
         list[str]: All users with submissions in the guild.
     """
-
     with Session(engine) as session:
         group_ids = select(CategoryGroup.GroupId).where(CategoryGroup.GuildId == guild_id)
         category_ids = select(Category.CategoryId).where(Category.GroupId.in_(group_ids))
         stmt = select(distinct(Score.UserName)).where(Score.CategoryId.in_(category_ids))
-        users_list: "list[str]" = list(session.scalars(stmt))
+        users_list: list[str] = list(session.scalars(stmt))
 
     # if string empty, return all users
     if not user_begin:
-        return users_list
+        return users_list[:25]
 
     # else find all users that start with user_begin
-    users = [user for user in users_list if user_begin.lower() in user.lower()]
+    users: list[str] = [user for user in users_list if user_begin.lower() in user.lower()]
 
-    return users
+    return users[:25]
 
 
 def format_highscore_message(session: Session, group: CategoryGroup) -> str:
@@ -179,7 +175,6 @@ def format_highscore_message(session: Session, group: CategoryGroup) -> str:
     Returns:
         str: Formatted string for discord message
     """
-
     ret_string = f"**{group.GroupName}**\n```"
 
     stmt = select(Guild).where(Guild.GuildId == group.GuildId)
@@ -201,17 +196,19 @@ def format_highscore_message(session: Session, group: CategoryGroup) -> str:
     max_cat_size: int = 0
     pad_length = group.PadLength
     for cat in session.scalars(stmt):
-        if cat.Size > max_cat_size:
-            max_cat_size = cat.Size
+        max_cat_size = max(cat.Size, max_cat_size)
         categories.append(cat)
         category_ids.append(cat.CategoryId)
 
     # get all scores in category group, load into data frame.
-    d_f = pd.read_sql_query(sql=session.query(Score).where(Score.CategoryId.in_(category_ids)).statement, con=engine)
+    d_f = pd.read_sql_query(
+        sql=session.query(Score).where(Score.CategoryId.in_(category_ids)).statement,
+        con=engine,
+    )
 
     # this list is what will be printed in the discord message
     # first string will be category list, others will be score printouts
-    str_list: "list[str]" = ["" for i in range(max_cat_size + 1)]
+    str_list: list[str] = ["" for i in range(max_cat_size + 1)]
     groups_df = d_f.groupby("CategoryId")
 
     # TODO figure out how to have less nests.
@@ -231,26 +228,22 @@ def format_highscore_message(session: Session, group: CategoryGroup) -> str:
             # add each score to list
             for ind in range(max_cat_size):  # need to subtract to deal with category name string
                 if ind in processed_group.index:
-                    user_length = group.UsernameLength
-                    username = processed_group["UserName"][ind][:user_length].ljust(user_length, " ")
+                    username = processed_group["UserName"][ind]
+                    score = processed_group["Score"][ind]
 
-                    # get score, pad to correct length
-                    if category.IsTimeRecord:
-                        # MM:SS.ms is 7 characters long
-                        # if there are single digit minutes, add a space for formatting.
-                        score = get_time_str(processed_group["Score"][ind])
-                        if score.find(":") and len(score.split(":", maxsplit=1)[0]) < 2:
-                            score = " " + score
-                    else:
-                        score = str(int(processed_group["Score"][ind])).rjust(7, " ")
-
-                    str_list[ind + 1] += f"{ind + 1}: {username} - {score}".ljust(pad_length, " ")
+                    str_list[ind + 1] += format_score_string(
+                        username,
+                        score,
+                        group.UsernameLength,
+                        category.IsTimeRecord,
+                        ind + 1,
+                        pad_length,
+                    )
+                # if not enough entries, pad out
+                elif ind + 1 <= category.Size:
+                    str_list[ind + 1] += f"{ind + 1}: ".ljust(pad_length, " ")
                 else:
-                    # if not enough entries, pad out
-                    if ind + 1 <= category.Size:
-                        str_list[ind + 1] += f"{ind + 1}: ".ljust(pad_length, " ")
-                    else:
-                        str_list[ind + 1] += "".ljust(pad_length, " ")
+                    str_list[ind + 1] += "".ljust(pad_length, " ")
         else:
             for ind in range(max_cat_size):
                 if ind + 1 <= category.Size:
@@ -262,7 +255,6 @@ def format_highscore_message(session: Session, group: CategoryGroup) -> str:
     # need to use index to allow for modifying the list
     for ind, line in enumerate(str_list):
         if len(line) > MAX_LINE_LENGTH:
-
             split_loc = int(MAX_LINE_LENGTH / pad_length) * pad_length
             new_line = line[split_loc:]
             str_list[ind] = line[:split_loc]
@@ -283,6 +275,43 @@ def format_highscore_message(session: Session, group: CategoryGroup) -> str:
     return ret_string + "```"
 
 
+def format_score_string(
+    username: str,
+    score: float,
+    username_length: int,
+    is_time_record: bool,
+    rank: int,
+    pad_length: int,
+) -> str:
+    """
+    Builds the string to show a user's score.
+
+    Args:
+        username (str): username.
+        score (int): score in int form.
+        username_length (float): limit to how long username is allowed to be.
+        is_time_record (bool): if the score represents an number or a time record.
+        rank (int): the user's rank.
+        pad_length (int): limit to how long the string can be.
+
+    Returns:
+        str: string to show user's score.
+    """
+    username = username[:username_length].ljust(username_length, " ")
+
+    # get score, pad to correct length
+    if is_time_record:
+        # MM:SS.ms is 7 characters long
+        # if there are single digit minutes, add a space for formatting.
+        score = get_time_str(score)
+        if score.find(":") and len(score.split(":", maxsplit=1)[0]) < 2:
+            score = " " + score
+    else:
+        score = str(int(score)).rjust(7, " ")
+
+    return f"{rank}: {username} - {score}".ljust(pad_length, " ")
+
+
 def get_time_str(time_in: float) -> str:
     """
     Formats a float value into the desired string format for a timestamp.
@@ -311,7 +340,6 @@ async def send_highscore_message(session: Session, guild: nextcord.Guild, group:
     Returns:
         nextcord.Message: Message object that was posted with group contents.
     """
-
     highscore_string = format_highscore_message(session, group)
     channel = guild.get_channel(group.ChannelId)
 
@@ -328,7 +356,11 @@ async def send_highscore_message(session: Session, guild: nextcord.Guild, group:
 
 
 async def submit_score(
-    interaction: nextcord.Interaction, group_id: int, category_id: int, username: str, score: str
+    interaction: nextcord.Interaction,
+    group_id: int,
+    category_id: int,
+    username: str,
+    score: str,
 ) -> None:
     """
     Adds passed score to group. Then updates group message by calling send_highscore_message.
@@ -341,7 +373,6 @@ async def submit_score(
         username (str): The user who submitted the score.
         score (str): Score to submit. Need to convert to correct type.
     """
-
     with Session(engine) as session:
         stmt = select(Category.IsTimeRecord).where(Category.CategoryId == category_id)
         is_time_record = session.scalar(stmt)
@@ -378,9 +409,8 @@ def add_preset_configuration(guild_id: int, config_str: str) -> None:
         guild_id (int): Guild id to add config to
         config_str (str): Config name to add
     """
-
     with Session(engine) as session:
-        with open(f"example_config/{config_str}.json", encoding="utf-8", mode="r") as file:
+        with open(f"example_config/{config_str}.json", encoding="utf-8") as file:
             config = json.load(file)
 
         for group_name, categorys in config["tables"].items():