Rename main file to agon.

This reverts commit 8595a12f7f.

agon.py

@@ -1,5 +1,5 @@
 """
-main file for highscores bot
+main file for agon
 """
 
 import logging

cogs/commands/__init__.py

@@ -6,6 +6,7 @@ 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
@@ -19,6 +20,7 @@ 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))

cogs/commands/help.py

@@ -0,0 +1,47 @@
+"""
+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
+        print(help_str)
+
+        await interaction.response.send_message(content=help_str)

cogs/commands/set.py

@@ -48,7 +48,7 @@ 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.

cogs/message_listener/__init__.py

@@ -11,7 +11,7 @@ from sqlalchemy.orm import Session
 
 # pylint: disable=import-error
 from classes.submission import SubmissionState
-from highscores import submission_objects
+from agon import submission_objects
 from utilities.sql_data_classes import Category, Guild, engine
 
 
@@ -45,7 +45,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

cogs/submission/submission_views.py

@@ -9,7 +9,7 @@ from sqlalchemy.orm import Session, aliased
 
 # pylint: disable=import-error
 from classes.submission import Submission, SubmissionState
-from highscores import submission_objects
+from agon import submission_objects
 from utilities.sql_data_classes import Category, CategoryGroup, Guild, engine
 
 from .verification_view import VerificationView

docker-compose.yml

@@ -6,6 +6,8 @@ services:
     container_name: "Highscores-DataBase"
     volumes:
       - highscores_data:/var/lib/mysql
+    ports:
+      - 3306:3306
     environment:
       - MYSQL_ROOT_PASSWORD=${SQL_PASS}
       - MYSQL_ROOT_USERNAME=${SQL_USER}

requirements.txt

@@ -1,6 +1,6 @@
 nextcord>=2.3.2
 python-dotenv>=0.20.0
 pandas>=1.5.2
-sqlalchemy>=1.4.44
+sqlalchemy<2.0
 pymysql>=1.0.2
 cryptography>=2.8