feat: Create basic controllers and implement initial functionality

- Added greet_user function in the greetUser.py to handle user greetings.
- Implemented basic structure for Flask and Discord bot controllers.
- Added initial documentation for the greet_user function.

Author: zaber-dev

app/Commands/Context/greet.py

@@ -0,0 +1,40 @@
+import disnake
+from disnake.ext import commands
+from app.Controllers.Discord.greetUser import greet_user
+
+class Greet(commands.Cog):
+    """
+    A cog that contains a command to greet users.
+
+    This cog defines a command that greets the user who invoked it. The greeting message is generated
+    using the greet_user function from the greetUser controller.
+
+    Attributes:
+        bot (commands.Bot): The bot instance that the cog is attached to.
+    """
+
+    def __init__(self, bot):
+        """
+        Initializes the Greet cog.
+
+        Args:
+            bot (commands.Bot): The bot instance that the cog is attached to.
+        """
+        self.bot = bot
+
+    @commands.command()
+    async def hello(self, ctx):
+        """
+        Command to greet the user who invoked it using the Controller: app/Controllers/Discord/greetUser.py.
+
+        This command uses the greet_user function to generate a greeting message for the user who invoked
+        the command and sends it as a response in the Discord channel.
+
+        Args:
+            ctx (commands.Context): The context in which the command was invoked.
+        """
+        greeting = greet_user(ctx.author.name)
+        await ctx.send(greeting)
+
+def setup(bot):
+    bot.add_cog(Greet(bot))

app/Commands/Context/ping.py

@@ -2,11 +2,35 @@
 from disnake.ext import commands
 
 class Ping(commands.Cog):
+    """
+    A cog that contains a command to check the bot's latency.
+
+    This cog defines a command named 'ping' that responds with the bot's latency
+    when invoked. The latency is calculated and returned in milliseconds.
+    
+    Attributes:
+        bot (commands.Bot): The bot instance that the cog is attached to.
+    """
+
     def __init__(self, bot):
+        """
+        Initializes the Ping cog.
+
+        Args:
+            bot (commands.Bot): The bot instance that the cog is attached to.
+        """
         self.bot = bot
 
     @commands.command()
     async def ping(self, ctx):
+        """
+        Command to check the bot's latency.
+
+        This command calculates the bot's latency and sends it as a response in the Discord channel.
+
+        Args:
+            ctx (commands.Context): The context in which the command was invoked.
+        """
         latency = round(self.bot.latency * 1000)  # Calculate bot's latency in milliseconds
         await ctx.send(f'Pong! Latency: {latency}ms')
 

app/Commands/Slash/greet.py

@@ -0,0 +1,43 @@
+import disnake
+from disnake.ext import commands
+from app.Controllers.Discord.greetUser import greet_user
+
+class GreetSlash(commands.Cog):
+    """
+    A cog that contains a command to greet users.
+
+    This cog defines a command that greets the user who invoked it. The greeting message is generated
+    using the greet_user function from the greetUser controller.
+
+    Attributes:
+        bot (commands.Bot): The bot instance that the cog is attached to.
+    """
+
+    def __init__(self, bot):
+        """
+        Initializes the Greet cog.
+
+        Args:
+            bot (commands.Bot): The bot instance that the cog is attached to.
+        """
+        self.bot = bot
+
+    @commands.slash_command(
+        name="hello", 
+        description="Greet the user"
+    )
+    async def hello(self, ctx):
+        """
+        Command to greet the user who invoked it using the Controller: app/Controllers/Discord/greetUser.py.
+
+        This command uses the greet_user function to generate a greeting message for the user who invoked
+        the command and sends it as a response in the Discord channel.
+
+        Args:
+            ctx (commands.Context): The context in which the command was invoked.
+        """
+        greeting = greet_user(ctx.author.name)
+        await ctx.send(greeting)
+
+def setup(bot):
+    bot.add_cog(GreetSlash(bot))

app/Commands/Slash/ping.py

@@ -2,15 +2,38 @@
 from disnake.ext import commands
 
 class PingSlash(commands.Cog):
+    """
+    A cog that contains a slash command to check the bot's latency.
+
+    This cog defines a slash command named 'ping' that responds with the bot's latency
+    when invoked. The latency is calculated and returned in milliseconds.
+    
+    Attributes:
+        bot (commands.Bot): The bot instance that the cog is attached to.
+    """
+
     def __init__(self, bot):
+        """
+        Initializes the PingSlash cog.
+
+        Args:
+            bot (commands.Bot): The bot instance that the cog is attached to.
+        """
         self.bot = bot
 
     @commands.slash_command(
         name="ping",
         description="Check the bot's latency",
     )
     async def ping(self, ctx):
-        """Command to check the bot's latency"""
+        """
+        Command to check the bot's latency.
+
+        This command calculates the bot's latency and sends it as a response in the Discord channel.
+
+        Args:
+            ctx (commands.Context): The context in which the command was invoked.
+        """
         await ctx.send(f"Pong! Latency: {round(self.bot.latency * 1000)}ms")
 
 def setup(bot):

app/Controllers/Discord/greetUser.py

@@ -0,0 +1,15 @@
+def greet_user(name):
+    """
+    Controller function to greet a user in Discord.
+
+    This function takes the name of a user and returns a greeting message. It can be used in a Discord bot
+    to send personalized greetings to users.
+
+    Args:
+        name (str): The name of the user.
+
+    Returns:
+        str: A greeting message.
+    """
+    # Do some processing here
+    return f"Hello, **{name}**!"

app/Controllers/Flask/greetUser.py

@@ -0,0 +1,15 @@
+def greet_user(name):
+    """
+    Controller function to greet a user.
+
+    This function is called when the user visits the /example route. It processes the user's name
+    and returns a greeting message in HTML format.
+
+    Args:
+        name (str): The name of the user.
+
+    Returns:
+        str: An HTML string with a greeting message.
+    """
+    # Do some processing here
+    return f"<h1>Hello, {name}!</h1>"

routes/web.py

@@ -1,5 +1,30 @@
 from flask import current_app as app, render_template
+from app.Controllers.Flask.greetUser import greet_user
 
 @app.route('/')
 def home():
-    return render_template('index.html')
+    """
+    Render the home page.
+
+    This route renders the index.html template when the user visits the root URL.
+
+    Returns:
+        str: The rendered HTML of the home page.
+    """
+    return render_template('index.html')
+
+@app.route('/<name>')
+def api_hello(name):
+    """
+    Greet the user with the provided name using the Controller: app/Controllers/Discord/greetUser.py.
+
+    This route calls the greet_user function to generate a greeting message for the user
+    with the given name and returns it as a response.
+
+    Args:
+        name (str): The name of the user.
+
+    Returns:
+        str: A greeting message for the user.
+    """
+    return greet_user(name)