updating for pylint

Author: damienjburks

src/guildmaster/__init__.py

@@ -1 +1,5 @@
+"""
+This is the __init__.py file for the GuildMaster package.
+It initializes the package and sets the version.
+"""
 __version__ = "1.1.1"

src/guildmaster/cli.py

@@ -1,3 +1,7 @@
+"""
+# guildmaster.cli
+A command line interface for managing Discord server tasks and settings.
+"""
 import sys
 import fire
 from guildmaster.tasks.role_manager import DiscordRoleManager
@@ -13,6 +17,10 @@ def __init__(self):
 
 
 def main():
+    """
+    Main entry point for the GuildMaster CLI.
+    Initializes the command line interface and handles exceptions.
+    """
     try:
         fire.Fire(name="guildmaster", component=GuildMasterCommands)
     except KeyboardInterrupt:

src/guildmaster/client/discord_client.py

@@ -1,3 +1,8 @@
+"""
+# guildmaster.client.discord_client
+A module for managing the Discord client connection.
+This module provides functionality to connect to Discord using a bot token.
+"""
 import os
 import discord
 from discord.ext import commands
@@ -6,13 +11,22 @@
 
 
 class DiscordClient:
+    """
+    A class for managing the Discord client connection.
+    """
     def __init__(self):
         intents = discord.Intents.default()
         intents.members = True
         self.bot = commands.Bot(command_prefix="!", intents=intents)
 
     def run(self):
+        """
+        Run the Discord bot using the provided token.
+        """
         self.bot.run(TOKEN)
 
     def close(self):
+        """
+        Close the Discord bot connection.
+        """
         self.bot.close()

src/guildmaster/config/logger.py

@@ -1,7 +1,14 @@
+"""
+A module for configuring logging in the GuildMaster application.
+"""
 import logging
 
 
 class Logger:
+    """
+    A class for setting up a logger for the GuildMaster application.
+    """
+    
     @staticmethod
     def setup_logger(name: str, level: int = logging.INFO) -> logging.Logger:
         """

src/guildmaster/tasks/role_manager.py

@@ -1,3 +1,8 @@
+"""
+# guildmaster.tasks.role_manager
+A module for managing roles in a Discord server.
+This module provides functionality to assign a specific role to all members of a Discord server.
+"""
 import asyncio
 import discord
 from tqdm.asyncio import tqdm