Merge pull request #35 from wlinator/optimization

Optimization

.github/workflows/docker-image.yml

@@ -17,8 +17,7 @@ jobs:
       packages: write
 
     steps:
-      -
+      - name: Docker meta
-        name: Docker meta
         id: meta
         uses: docker/metadata-action@v5
         with:
@@ -31,25 +30,21 @@ jobs:
             type=semver,pattern={{version}}
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}
-      -
+      - name: Set up Docker Buildx
-        name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
-      -
+      - name: Login to Docker Hub
-        name: Login to Docker Hub
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
+      - name: Login to GHCR
-        name: Login to GHCR
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-      -
+      - name: Build and push
-        name: Build and push
         uses: docker/build-push-action@v6
         with:
           push: ${{ github.event_name != 'pull_request' }}

CONTRIBUTING.md

@@ -1,6 +1,7 @@
 # Contributing to Luminara
 
-Thank you for your interest in contributing to Lumi! We welcome contributions from the community to help improve and expand the bot's functionality. Please follow these guidelines when contributing:
+Thank you for your interest in contributing to Lumi! We welcome contributions from the community to help improve and
+expand the bot's functionality. Please follow these guidelines when contributing:
 
 ## Getting Started
 
@@ -28,17 +29,21 @@ Thank you for your interest in contributing to Lumi! We welcome contributions fr
 
 1. **Create a Branch:** Create a new branch for your changes.
 2. **Code Style:** Adhere to the existing code style and formatting conventions.
-3. **Strict Typing:** Always use strict typing (e.g., `str`, `int`, `List[str]`) for better code quality and maintainability.
+3. **Strict Typing:** Always use strict typing (e.g., `str`, `int`, `List[str]`) for better code quality and
-4. **Pre-Commit Checks:** Before committing, run pre-commit checks to ensure your code passes linting and formatting standards.
+   maintainability.
+4. **Pre-Commit Checks:** Before committing, run pre-commit checks to ensure your code passes linting and formatting
+   standards.
 5. **Clear Commit Messages:** Write clear and concise commit messages that describe the changes you made.
 
 ## Submitting Changes
 
-1. **Create a Pull Request:** Create a pull request (PR) from your branch to the `main` branch of the original repository.
+1. **Create a Pull Request:** Create a pull request (PR) from your branch to the `main` branch of the original
+   repository.
 2. **Review:** Your PR will be reviewed by the Sourcery & Lumi maintainers. Address any feedback or requested changes.
 3. **Merge:** Once approved, your PR will be merged into the main branch.
 
 ## Additional Notes
+
 * **Documentation:** If you add new functionality or change existing behavior, update or add the docstrings accordingly.
 
 Thank you for your contributions!

Luminara.py

@@ -9,10 +9,10 @@ import Client
 import config.parser
 import services.config_service
 import services.help_service
-from lib.constants import CONST
-from services.blacklist_service import BlacklistUserService
-from lib.exceptions.LumiExceptions import Blacklisted
 from db.database import run_migrations
+from lib.constants import CONST
+from lib.exceptions.LumiExceptions import Blacklisted
+from services.blacklist_service import BlacklistUserService
 
 # Remove the default logger configuration
 logger.remove()

README.md

@@ -2,14 +2,15 @@
 
 ![Lumi art](https://git.wlinator.org/assets/img/logo.png)
 
-
 ## Self-Hosting
 
-Self-hosting refers to running Luminara on your own server or computer, rather than using the publicly hosted version. This approach offers the ability to manage your own instance of the bot and give it a custom name and avatar.
+Self-hosting refers to running Luminara on your own server or computer, rather than using the publicly hosted version.
+This approach offers the ability to manage your own instance of the bot and give it a custom name and avatar.
 
 ### Requirements
 
 Before you begin, make sure you have the following installed on your system:
+
 - [Docker](https://docs.docker.com/get-docker/)
 - [Docker Compose](https://docs.docker.com/compose/install/)
 
@@ -25,7 +26,8 @@ Additionally, you'll need to create a Discord bot application and obtain a token
 
 ### Running Luminara:
 
-1. Copy the contents from [`docker-compose.prod.yml`](docker-compose.prod.yml) to a new file named `docker-compose.yml` in an empty directory.
+1. Copy the contents from [`docker-compose.prod.yml`](docker-compose.prod.yml) to a new file named `docker-compose.yml`
+   in an empty directory.
 
 2. Copy the contents from [`.env.example`](.env.example) to a new file named `.env` in the same directory.
 

SECURITY.md

@@ -5,7 +5,7 @@
 Versions currently being supported with security updates.
 
 | Version | Supported          |
-| ------- | ------------------ |
+|---------|--------------------|
 | 2.x     | :white_check_mark: |
 | 1.x     | :x:                |
 | < 1.0   | :x:                |

db/database.py

@@ -1,10 +1,11 @@
-import mysql.connector
-from loguru import logger
-from mysql.connector import pooling
 import os
 import pathlib
 import re
 
+import mysql.connector
+from loguru import logger
+from mysql.connector import pooling
+
 from lib.constants import CONST
 
 

handlers/reaction_handler.py

@@ -1,4 +1,5 @@
 import contextlib
+
 from discord import Message
 from discord.ext.commands import Cog
 from loguru import logger

lib/exceptions/LumiExceptions.py

@@ -1,4 +1,5 @@
 from discord.ext import commands
+
 from lib.constants import CONST
 
 

lib/formatter.py

@@ -3,9 +3,9 @@ import textwrap
 import discord
 from discord.ext import commands
 from pytimeparse import parse
-from lib.exceptions.LumiExceptions import LumiException
-from lib.constants import CONST
 
+from lib.constants import CONST
+from lib.exceptions.LumiExceptions import LumiException
 from services.config_service import GuildConfig
 
 

modules/admin/award.py

@@ -1,4 +1,5 @@
 import discord
+
 from lib.constants import CONST
 from lib.embed_builder import EmbedBuilder
 from services.currency_service import Currency

modules/admin/blacklist.py

@@ -1,9 +1,10 @@
 from typing import Optional
 
 import discord
+
 from lib.constants import CONST
-from services.blacklist_service import BlacklistUserService
 from lib.embed_builder import EmbedBuilder
+from services.blacklist_service import BlacklistUserService
 
 
 async def blacklist_user(

modules/admin/sql.py

@@ -1,10 +1,10 @@
 import mysql.connector
+
+from db import database
 from lib.constants import CONST
 from lib.embed_builder import EmbedBuilder
 from lib.formatter import shorten
 
-from db import database
-
 
 async def select_cmd(ctx, query: str):
     if query.lower().startswith("select "):

modules/admin/sync.py

@@ -1,7 +1,8 @@
 import discord
+
+from lib.constants import CONST
 from lib.embed_builder import EmbedBuilder
 from lib.exceptions.LumiExceptions import LumiException
-from lib.constants import CONST
 
 
 async def sync_commands(client, ctx):

modules/birthdays/__init__.py

@@ -1,9 +1,10 @@
 import datetime
-import pytz
 
 import discord
+import pytz
 from discord.commands import SlashCommandGroup
 from discord.ext import commands, tasks
+
 from lib import checks
 from lib.constants import CONST
 from modules.birthdays import birthday, daily_check

modules/birthdays/birthday.py

@@ -4,8 +4,8 @@ import datetime
 import discord
 from discord.ext import commands
 
-from lib.embed_builder import EmbedBuilder
 from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
 from services.birthday_service import Birthday
 
 

modules/birthdays/daily_check.py

@@ -1,10 +1,12 @@
 import asyncio
 import random
+
 from loguru import logger
+
 from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
 from services.birthday_service import Birthday
 from services.config_service import GuildConfig
-from lib.embed_builder import EmbedBuilder
 
 
 async def daily_birthday_check(client):

modules/config/__init__.py

@@ -1,7 +1,8 @@
 import discord
-from discord.ext.commands import guild_only
 from discord.commands import SlashCommandGroup
 from discord.ext import bridge, commands
+from discord.ext.commands import guild_only
+
 from modules.config import (
     c_birthday,
     c_boost,

modules/config/c_birthday.py

@@ -1,6 +1,7 @@
 import discord
-from lib.embed_builder import EmbedBuilder
+
 from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
 from services.config_service import GuildConfig
 
 

modules/config/c_boost.py

@@ -1,9 +1,10 @@
 import discord
-from lib.embed_builder import EmbedBuilder
+
-from lib.constants import CONST
-from services.config_service import GuildConfig
-from lib.exceptions.LumiExceptions import LumiException
 import lib.formatter
+from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
+from lib.exceptions.LumiExceptions import LumiException
+from services.config_service import GuildConfig
 
 
 async def set_boost_channel(ctx, channel: discord.TextChannel):

modules/config/c_level.py

@@ -1,8 +1,9 @@
 import discord
-from lib.embed_builder import EmbedBuilder
+
-from lib.constants import CONST
-from services.config_service import GuildConfig
 from lib import formatter
+from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
+from services.config_service import GuildConfig
 
 
 async def set_level_channel(ctx, channel: discord.TextChannel):

modules/config/c_moderation.py

@@ -1,8 +1,9 @@
 import discord
-from lib.embed_builder import EmbedBuilder
+
 from lib.constants import CONST
-from services.moderation.modlog_service import ModLogService
+from lib.embed_builder import EmbedBuilder
 from lib.exceptions.LumiExceptions import LumiException
+from services.moderation.modlog_service import ModLogService
 
 
 async def set_mod_log_channel(ctx, channel: discord.TextChannel):

modules/config/c_prefix.py

@@ -1,5 +1,5 @@
-from lib.embed_builder import EmbedBuilder
 from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
 from services.config_service import GuildConfig
 
 

modules/config/c_show.py

@@ -1,8 +1,10 @@
-import discord
 from typing import List, Tuple, Optional
+
+import discord
 from discord import Guild
-from lib.embed_builder import EmbedBuilder
+
 from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
 from services.config_service import GuildConfig
 from services.moderation.modlog_service import ModLogService
 

modules/config/xp_reward.py

@@ -1,7 +1,7 @@
 import discord
 
-from services.xp_service import XpRewardService
 from lib.constants import CONST
+from services.xp_service import XpRewardService
 
 
 async def show(ctx):

modules/economy/__init__.py

@@ -1,6 +1,7 @@
 import discord
-from discord.ext.commands import guild_only
 from discord.ext import bridge, commands
+from discord.ext.commands import guild_only
+
 from modules.economy import balance, blackjack, daily, give, slots
 
 

modules/economy/blackjack.py

@@ -7,10 +7,10 @@ from discord.ext import commands
 from loguru import logger
 
 from lib import interaction
+from lib.constants import CONST
+from lib.exceptions.LumiExceptions import LumiException
 from services.currency_service import Currency
 from services.stats_service import BlackJackStats
-from lib.exceptions.LumiExceptions import LumiException
-from lib.constants import CONST
 
 est = pytz.timezone("US/Eastern")
 active_blackjack_games = {}

modules/economy/slots.py

@@ -7,11 +7,10 @@ import discord
 import pytz
 from discord.ext import commands
 
+from lib.constants import CONST
 from services.currency_service import Currency
 from services.stats_service import SlotsStats
 
-from lib.constants import CONST
-
 est = pytz.timezone("US/Eastern")
 
 

modules/levels/__init__.py

@@ -1,6 +1,6 @@
 import discord
-from discord.ext.commands import guild_only
 from discord.ext import bridge, commands
+from discord.ext.commands import guild_only
 
 from modules.levels import leaderboard, level
 

modules/misc/__init__.py

@@ -1,9 +1,9 @@
 from datetime import datetime
 
 import discord
-from discord.ext.commands import guild_only
 from discord.commands import SlashCommandGroup
 from discord.ext import bridge, commands, tasks
+from discord.ext.commands import guild_only
 
 from Client import LumiBot
 from modules.config import c_prefix

modules/moderation/ban.py

@@ -1,13 +1,14 @@
 import asyncio
+from typing import Optional
+
 import discord
+from discord.ext.commands import MemberConverter
 
 from lib import formatter
 from lib.constants import CONST
 from lib.embed_builder import EmbedBuilder
 from modules.moderation.utils.actionable import async_actionable
 from modules.moderation.utils.case_handler import create_case
-from typing import Optional
-from discord.ext.commands import MemberConverter
 
 
 async def ban_user(cog, ctx, target: discord.User, reason: Optional[str] = None):

modules/moderation/cases.py

@@ -1,16 +1,18 @@
 import asyncio
+
 import discord
+from discord.ext import pages
 from discord.ext.commands import UserConverter
-from services.moderation.case_service import CaseService
+
+from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
+from lib.formatter import format_case_number
 from modules.moderation.utils.case_embed import (
     create_case_embed,
     create_case_list_embed,
 )
-from lib.embed_builder import EmbedBuilder
-from lib.constants import CONST
-from discord.ext import pages
-from lib.formatter import format_case_number
 from modules.moderation.utils.case_handler import edit_case_modlog
+from services.moderation.case_service import CaseService
 
 case_service = CaseService()
 

modules/moderation/kick.py

@@ -1,13 +1,14 @@
 import asyncio
+from typing import Optional
+
 import discord
+from discord.ext.commands import UserConverter, MemberConverter
 
 from lib import formatter
 from lib.constants import CONST
 from lib.embed_builder import EmbedBuilder
 from modules.moderation.utils.actionable import async_actionable
 from modules.moderation.utils.case_handler import create_case
-from typing import Optional
-from discord.ext.commands import UserConverter, MemberConverter
 
 
 async def kick_user(cog, ctx, target: discord.Member, reason: Optional[str] = None):

modules/moderation/softban.py

@@ -1,7 +1,9 @@
 import asyncio
-import discord
 from typing import Optional
+
+import discord
 from discord.ext.commands import MemberConverter, UserConverter
+
 from lib import formatter
 from lib.constants import CONST
 from lib.embed_builder import EmbedBuilder

modules/moderation/timeout.py

@@ -1,15 +1,16 @@
 import asyncio
-import discord
 import datetime
+from typing import Optional
+
+import discord
+from discord.ext.commands import UserConverter, MemberConverter
 
 from lib import formatter
 from lib.constants import CONST
 from lib.embed_builder import EmbedBuilder
+from lib.formatter import format_duration_to_seconds, format_seconds_to_duration_string
 from modules.moderation.utils.actionable import async_actionable
 from modules.moderation.utils.case_handler import create_case
-from typing import Optional
-from discord.ext.commands import UserConverter, MemberConverter
-from lib.formatter import format_duration_to_seconds, format_seconds_to_duration_string
 
 
 async def timeout_user(

modules/moderation/utils/actionable.py

@@ -1,6 +1,7 @@
 import discord
-from lib.exceptions.LumiExceptions import LumiException
+
 from lib.constants import CONST
+from lib.exceptions.LumiExceptions import LumiException
 
 
 async def async_actionable(

modules/moderation/utils/case_embed.py

@@ -1,9 +1,11 @@
-import discord
-from lib.embed_builder import EmbedBuilder
-from lib.constants import CONST
-from lib.formatter import format_case_number
-from typing import Optional
 import datetime
+from typing import Optional
+
+import discord
+
+from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
+from lib.formatter import format_case_number
 from lib.formatter import format_seconds_to_duration_string
 
 

modules/moderation/utils/case_handler.py

@@ -1,10 +1,12 @@
+from typing import Optional
+
 import discord
+from discord.ext.commands import TextChannelConverter, UserConverter
 from loguru import logger
+
+from modules.moderation.utils.case_embed import create_case_embed
 from services.moderation.case_service import CaseService
 from services.moderation.modlog_service import ModLogService
-from modules.moderation.utils.case_embed import create_case_embed
-from typing import Optional
-from discord.ext.commands import TextChannelConverter, UserConverter
 
 case_service = CaseService()
 modlog_service = ModLogService()

modules/moderation/warn.py

@@ -1,11 +1,13 @@
-import discord
-from typing import Optional
-from discord.ext.commands import UserConverter, MemberConverter
 import asyncio
-from lib.embed_builder import EmbedBuilder
+from typing import Optional
+
+import discord
+from discord.ext.commands import UserConverter, MemberConverter
+
 from lib.constants import CONST
-from modules.moderation.utils.case_handler import create_case
+from lib.embed_builder import EmbedBuilder
 from modules.moderation.utils.actionable import async_actionable
+from modules.moderation.utils.case_handler import create_case
 
 
 async def warn_user(ctx, target: discord.Member, reason: Optional[str]):

modules/triggers/__init__.py

@@ -1,7 +1,7 @@
 import discord
-from discord.ext.commands import guild_only
 from discord.commands import SlashCommandGroup
 from discord.ext import commands
+from discord.ext.commands import guild_only
 
 from Client import LumiBot
 from modules.triggers.add import add_reaction

modules/triggers/add.py

@@ -1,11 +1,12 @@
 from typing import Optional
 
 from discord.ext import bridge
-from services.reactions_service import CustomReactionsService
+
-from lib.exceptions.LumiExceptions import LumiException
+from lib import formatter
 from lib.constants import CONST
 from lib.embed_builder import EmbedBuilder
-from lib import formatter
+from lib.exceptions.LumiExceptions import LumiException
+from services.reactions_service import CustomReactionsService
 
 
 async def add_reaction(

modules/triggers/delete.py

@@ -1,8 +1,9 @@
 from discord.ext import bridge
-from services.reactions_service import CustomReactionsService
+
-from lib.embed_builder import EmbedBuilder
 from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
 from lib.exceptions.LumiExceptions import LumiException
+from services.reactions_service import CustomReactionsService
 
 
 async def delete_reaction(ctx: bridge.Context, reaction_id: int) -> None:

modules/triggers/list.py

@@ -1,11 +1,12 @@
+from typing import Any, Dict, List
+
+import discord
 from discord.ext import bridge, pages
+
+from lib import formatter
 from lib.constants import CONST
 from lib.embed_builder import EmbedBuilder
 from services.reactions_service import CustomReactionsService
-from typing import Any, Dict, List
-from lib import formatter
-
-import discord
 
 
 async def list_reactions(ctx: bridge.Context) -> None:

services/daily_service.py

@@ -2,6 +2,7 @@ from datetime import datetime, timedelta
 from typing import List, Optional, Tuple
 
 import pytz
+
 from db import database
 from lib.constants import CONST
 from services.currency_service import Currency

services/help_service.py

@@ -1,8 +1,8 @@
 import discord
 from discord.ext import commands
 
-from lib.embed_builder import EmbedBuilder
 from lib.constants import CONST
+from lib.embed_builder import EmbedBuilder
 from lib.exceptions.LumiExceptions import LumiException
 
 

services/moderation/case_service.py

@@ -1,6 +1,7 @@
-from db.database import execute_query, select_query_one, select_query_dict
 from typing import Optional, Dict, Any, List
 
+from db.database import execute_query, select_query_one, select_query_dict
+
 
 class CaseService:
     def __init__(self):

services/moderation/modlog_service.py

@@ -1,6 +1,7 @@
-from db.database import execute_query, select_query_one
 from typing import Optional
 
+from db.database import execute_query, select_query_one
+
 
 class ModLogService:
     def __init__(self):