feat: adjust settings to use guild configs

.pdm-python

@@ -1 +1 @@
-.venv/bin/python
+/Users/jcoffee5/git/public/JacobCoffee/byte/.venv/bin/python

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 default_language_version:
-  python: "3.11"
+  python: "3.12"
 default_install_hook_types: [commit-msg, pre-commit]
 repos:
   - repo: https://github.com/compilerla/conventional-pre-commit

.tool-versions

@@ -1 +1,2 @@
 python 3.11
+python 3.12

Makefile

@@ -60,6 +60,34 @@ install: clean destroy										## Install the project, dependencies, and pre-co
 	@$(MAKE) install-frontend
 	@echo "=> Install complete! Note: If you want to re-install re-run 'make install'"
 
+up-container: ## Start the Byte database container
+	@echo "=> Starting Byte database container"
+	@docker compose -f docker-compose.infra.yml up -d
+	@echo "=> Started Byte database container"
+
+clean-container: ## Stop, remove, and wipe the Byte database container and volume
+	@echo "=> Stopping and removing Byte database container"
+	@docker stop byte-db-1
+	@docker rm byte-db-1
+	@docker volume rm byte_db-data
+	@echo "=> Stopped and removed Byte database container"
+
+load-container: migrate ## Perform database migrations and load test data into the Byte database container
+	@echo "=> Loading database migrations and test data"
+	@echo "not yet implemented"
+	@echo "=> Loaded database migrations and test data"
+
+refresh-container: clean-container up-container load-container ## Refresh the Byte database container
+
+
+.PHONY: refresh-lockfiles
+refresh-lockfiles:                                 ## Sync lockfiles with requirements files.
+	$(PDM) update --update-reuse -G:all
+
+.PHONY: lock
+lock:                                             ## Rebuild lockfiles from scratch, updating all dependencies
+	$(PDM) update --update-eager -G:all
+
 # =============================================================================
 # Tests, Linting, Coverage
 # =============================================================================

byte_bot/byte/__init__.py

@@ -2,9 +2,9 @@
 
 from __future__ import annotations
 
-from byte_bot.byte import bot, lib
+from byte_bot.byte import bot, lib, plugins, views
 from byte_bot.byte.lib.log import setup_logging
 
-__all__ = ["bot", "lib"]
+__all__ = ("bot", "lib", "views", "setup_logging", "plugins")
 
 setup_logging()

byte_bot/byte/bot.py

@@ -10,6 +10,7 @@
 from discord import Activity, Forbidden, Intents, Member, Message, NotFound
 from discord.ext.commands import Bot, CommandError, Context, ExtensionAlreadyLoaded
 from dotenv import load_dotenv
+from httpx import ConnectError
 
 from byte_bot.byte.lib import settings
 from byte_bot.byte.lib.log import get_logger
@@ -23,18 +24,6 @@
 load_dotenv()
 
 
-async def on_member_join(member: Member) -> None:
-    """Handle member join event.
-
-    Args:
-        member: Member object.
-    """
-    await member.send(
-        f"Welcome to {member.guild.name}! Please make sure to read the rules if you haven't already. "
-        f"Feel free to ask any questions you have in the help channel."
-    )
-
-
 class Byte(Bot):
     """Byte Bot Base Class."""
 
@@ -112,10 +101,11 @@ async def on_member_join(member: Member) -> None:
         Args:
             member: Member object.
         """
-        await member.send(
-            f"Welcome to {member.guild.name}! Please make sure to read the rules if you haven't already. "
-            f"Feel free to ask any questions you have in the help channel."
-        )
+        if not member.bot:
+            await member.send(
+                f"Welcome to {member.guild.name}! Please make sure to read the rules if you haven't already. "
+                f"Feel free to ask any questions you have in the help channel."
+            )
 
     async def on_guild_join(self, guild: discord.Guild) -> None:
         """Handle guild join event.
@@ -126,13 +116,33 @@ async def on_guild_join(self, guild: discord.Guild) -> None:
         await self.tree.sync(guild=guild)
         api_url = f"http://0.0.0.0:8000/api/guilds/create?guild_id={guild.id}&guild_name={guild.name}"
 
-        async with httpx.AsyncClient() as client:
-            response = await client.post(api_url)
-
-            if response.status_code == httpx.codes.CREATED:
-                logger.info("successfully added guild %s (ID: %s)", guild.name, guild.id)
-            else:
-                logger.error("%s joined guild '%s' but was not added to database", self.user.name, guild.name)
+        try:
+            async with httpx.AsyncClient() as client:
+                response = await client.post(api_url)
+
+                if response.status_code == httpx.codes.CREATED:
+                    logger.info("successfully added guild %s (id: %s)", guild.name, guild.id)
+                    embed = discord.Embed(
+                        title="Guild Joined",
+                        description=f"Joined guild {guild.name} (ID: {guild.id})",
+                        color=discord.Color.green(),
+                    )
+                else:
+                    embed = discord.Embed(
+                        title="Guild Join Failed",
+                        description=f"Joined guild, but failed to add guild {guild.name} (ID: {guild.id}) to database",
+                        color=discord.Color.red(),
+                    )
+
+                if dev_guild := self.get_guild(settings.discord.DEV_GUILD_ID):
+                    if dev_channel := dev_guild.get_channel(settings.discord.DEV_GUILD_INTERNAL_ID):
+                        await dev_channel.send(embed=embed)
+                    else:
+                        logger.error("dev channel not found.")
+                else:
+                    logger.error("dev guild not found.")
+        except ConnectError:
+            logger.exception("failed to connect to api to add guild %s (id: %s)", guild.name, guild.id)
 
 
 def run_bot() -> None:

byte_bot/byte/lib/__init__.py

@@ -1,10 +1,11 @@
 """Byte library module."""
 
-from byte_bot.byte.lib import common, log, settings, utils
+from byte_bot.byte.lib import common, log, settings, types, utils
 
 __all__ = [
     "settings",
     "utils",
     "log",
     "common",
+    "types",
 ]

byte_bot/byte/lib/checks.py

@@ -0,0 +1,65 @@
+""":doc:`Checks <discord.py:Checks>` for Byte."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from discord.ext.commands import CheckFailure, Context, check
+
+from byte_bot.byte.lib import settings
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from discord.ext.commands._types import Check
+
+__all__ = ("is_byte_dev", "is_guild_admin")
+
+
+def is_guild_admin() -> Callable[[Context], Check]:
+    """Check if the user is a guild admin.
+
+    Returns:
+        A check function.
+    """
+
+    async def predicate(ctx: Context) -> bool:
+        """Check if the user is a guild admin.
+
+        Args:
+            ctx: Context object.
+
+        Returns:
+            True if the user is a guild admin, False otherwise.
+        """
+        if not (member := ctx.guild.get_member(ctx.author.id)):
+            msg = "Member not found in the guild."
+            raise CheckFailure(msg)
+        return member.guild_permissions.administrator
+
+    return check(predicate)
+
+
+def is_byte_dev() -> Callable[[Context], Check]:
+    """Determines if the user is a Byte developer or owner.
+
+    Returns:
+        A check function.
+    """
+
+    async def predicate(ctx: Context) -> bool:
+        """Check if the user is a Byte developer or owner.
+
+        Args:
+            ctx: Context object.
+
+        Returns:
+            True if the user is a Byte developer or owner, False otherwise.
+        """
+        return (
+            await ctx.bot.is_owner(ctx.author)
+            or ctx.author.id == settings.discord.DEV_USER_ID
+            or any(role.name == "byte-dev" for role in ctx.author.roles)
+        )
+
+    return check(predicate)

byte_bot/byte/lib/common/__init__.py

@@ -3,11 +3,55 @@
 .. todo:: temporary, these are not multi-guild friendly.
 """
 
-from byte_bot.byte.lib.common import assets, colors, guilds, links
+from typing import Any
+
+from byte_bot.byte.lib.common import assets, colors, guilds, links, mention
 
 __all__ = (
     "assets",
     "colors",
     "guilds",
     "links",
+    "config_options",
+    "mention",
 )
+
+config_options: list[dict[str, Any]] = [
+    {
+        "label": "Server Settings",
+        "description": "Configure overall server settings",
+        "sub_settings": [
+            {"label": "Prefix", "field": "prefix", "data_type": "String"},
+            {"label": "Help Channel ID", "field": "help_channel_id", "data_type": "Integer"},
+            {"label": "Sync Label", "field": "sync_label", "data_type": "String"},
+            {"label": "Issue Linking", "field": "issue_linking", "data_type": "True/False"},
+            {"label": "Comment Linking", "field": "comment_linking", "data_type": "True/False"},
+            {"label": "PEP Linking", "field": "pep_linking", "data_type": "True/False"},
+        ],
+    },
+    {
+        "label": "GitHub Settings",
+        "description": "Configure GitHub settings",
+        "sub_settings": [
+            {"label": "Discussion Sync", "field": "discussion_sync", "data_type": "True/False"},
+            {"label": "GitHub Organization", "field": "github_organization", "data_type": "String"},
+            {"label": "GitHub Repository", "field": "github_repository", "data_type": "String"},
+        ],
+    },
+    {
+        "label": "StackOverflow Settings",
+        "description": "Configure StackOverflow settings",
+        "sub_settings": [
+            {"label": "Tag Name", "field": "tag_name", "data_type": "Comma-Separated String"},
+        ],
+    },
+    {
+        "label": "Allowed Users",
+        "description": "Configure allowed users",
+        "sub_settings": [
+            {"label": "User ID", "field": "user_id", "data_type": "Integer"},
+        ],
+    },
+    # Forum Settings: Configure help and showcase forum settings
+    # Byte Settings: Configure meta-level Byte features
+]

byte_bot/byte/lib/common/colors.py

@@ -6,8 +6,13 @@
 from typing import Final
 
 # --- Colors
-litestar_blue: Final = 0x7289DA
+litestar_blue: Final = 0x202235
+litestar_yellow: Final = 0xEDB641
+
 python_blue: Final = 0x4B8BBE
 python_yellow: Final = 0xFFD43B
+
 astral_yellow: Final = 0xD7FF64
 astral_purple: Final = 0x261230
+
+byte_teal: Final = 0x42B1A8

byte_bot/byte/lib/common/links.py

@@ -6,11 +6,6 @@
 from typing import Final
 
 # --- Links
-litestar_issues: Final = "https://github.com/litestar-org/litestar/issues"
-github_litestar_projects: Final = "https://github.com/orgs/litestar-org/litestar/projects"
-github_org_projects: Final = "https://github.com/orgs/litestar-org/projects"
-pypi_litestar: Final = "https://pypi.org/project/litestar/"
-pypi_polyfactory: Final = "https://pypi.org/project/polyfactory/"
 mcve: Final = "https://stackoverflow.com/help/minimal-reproducible-example"
 pastebin: Final = "https://paste.pythondiscord.com"
 markdown_guide: Final = "https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-#h_01GY0DAKGXDEHE263BCAYEGFJA"