feat: update dependencies and build infrastructure (#91)

Author: JacobCoffee

.pre-commit-config.yaml

@@ -1,9 +1,9 @@
 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
-    rev: v3.4.0
+    rev: v4.2.0
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
@@ -17,19 +17,19 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.6.9"
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.11.13"
     hooks:
       - id: ruff
         args: ["--fix"]
       - id: ruff-format
   - repo: https://github.com/sourcery-ai/sourcery
-    rev: v1.23.0
+    rev: v1.37.0
     hooks:
       - id: sourcery
         args: [--diff=git diff HEAD, --no-summary]
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         additional_dependencies:
@@ -39,7 +39,7 @@ repos:
               .*\.json |.*\.svg |docs/changelog.rst
           )$
   - repo: https://github.com/asottile/blacken-docs
-    rev: 1.19.0
+    rev: 1.19.1
     hooks:
       - id: blacken-docs
   - repo: https://github.com/pre-commit/mirrors-prettier
@@ -53,7 +53,7 @@ repos:
   #       - id: curlylint
   #         args: ["--format", "stylish"]
   - repo: https://github.com/python-formate/flake8-dunder-all
-    rev: v0.4.1
+    rev: v0.5.0
     hooks:
       - id: ensure-dunder-all
         exclude: "test*|examples*|tools"
@@ -88,7 +88,7 @@ repos:
   #             discord-py,
   #           ]
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.384
+    rev: v1.1.402
     hooks:
       - id: pyright
         additional_dependencies:

.tool-versions

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

Makefile

@@ -20,15 +20,17 @@ UV 			    ?= 	uv $(UV_OPTS)
 help: ## Display this help text for Makefile
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
-upgrade:       ## Upgrade all dependencies to the latest stable versions
+upgrade: ## Upgrade all dependencies to the latest stable versions
+	@echo "=> Upgrading pre-commit"
+	@(UV_RUN_BIN) run pre-commit autoupdate
 	@if [ "$(USING_UV)" ]; then $(UV) lock --upgrade
 	@echo "Dependencies Updated"
 
 # =============================================================================
 # Developer Utils
 # =============================================================================
 
-install-uv: 										## Install latest version of UV
+install-uv: ## Install latest version of UV
 	@echo "=> Installing uv"
 	@curl -LsSf https://astral.sh/uv/install.sh | sh
 	@echo "=> uv installed"
@@ -37,29 +39,51 @@ install-pre-commit: ## Install pre-commit and install hooks
 	@echo "Installing pre-commit hooks"
 	@(UV_RUN_BIN) run pre-commit install --install-hooks --all
 	@(UV_RUN_BIN) run pre-commit install --hook-type commit-msg
+	@echo "=> pre-commit hooks installed, updating pre-commit hooks"
+	@(UV_RUN_BIN) run pre-commit autoupdate
 	@echo "pre-commit installed"
 
 .PHONY: install-frontend
-install-frontend: 									## Install the frontend dependencies
+install-frontend: ## Install the frontend dependencies
 	@echo "=> Installing frontend dependencies"
 	@nodeenv --python-virtualenv
 	@npm install
 	@echo "=> Frontend dependencies installed"
 
 .PHONY: install-backend
-install-backend: 									## Install the backend dependencies
+install-backend: ## Install the backend dependencies
 	@echo "=> Installing backend dependencies"
 	@$(UV) venv && $(UV) pip install --quiet -U wheel setuptools cython mypy pip
 	@$(UV) sync --all-extras --force-reinstall --dev
 	@echo "=> Backend dependencies installed"
 
 .PHONY: install
-install: clean destroy										## Install the project, dependencies, and pre-commit for local development
+install: clean destroy ## Install the project, dependencies, and pre-commit for local development
 	@if ! $(UV) --version > /dev/null; then $(MAKE) install-uv; fi
 	@$(MAKE) install-backend
 	@$(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, volume, network, and orphans
+	@echo "=> Stopping and removing Byte database container, volumes, networks, and orphans"
+	@docker compose -f docker-compose.infra.yml down -v --remove-orphans
+	@echo "=> Stopped and removed Byte database container, volumes, networks, and orphans"
+
+load-container: up-container migrate ## Perform database migrations and load test data into the Byte database container
+	@echo "=> Loading database migrations and test data"
+	@$(UV) run app database upgrade --no-prompt
+	@echo "rest not yet implemented"
+	@echo "=> Loaded database migrations and test data"
+
+refresh-container: clean-container up-container load-container ## Refresh the Byte database container
+
+
+
 # =============================================================================
 # Tests, Linting, Coverage
 # =============================================================================
@@ -76,6 +100,12 @@ fmt: ## Runs Ruff format, makes changes where necessary
 ruff: ## Runs Ruff
 	@$(UV) run --no-sync ruff check . --unsafe-fixes --fix
 
+ruff-check: ## Runs Ruff without changing files
+	@$(UV) run --no-sync ruff check .
+
+ruff-noqa: ## Runs Ruff, adding noqa comments to disable warnings
+	@$(UV) run --no-sync ruff check . --add-noqa
+
 test:  ## Run the tests
 	@$(UV) run --no-sync pytest tests
 
@@ -89,29 +119,29 @@ check-all: lint test fmt-check coverage ## Run all linting, tests, and coverage
 # =============================================================================
 # Docs
 # =============================================================================
-docs-clean: 										## Dump the existing built docs
+docs-clean: ## Dump the existing built docs
 	@echo "=> Cleaning documentation build assets"
 	@rm -rf docs/_build
 	@echo "=> Removed existing documentation build assets"
 
-docs-serve: docs-clean 								## Serve the docs locally
+docs-serve: docs-clean ## Serve the docs locally
 	@echo "=> Serving documentation"
 	$(UV) run sphinx-autobuild docs docs/_build/ -j auto --watch byte_bot --watch docs --watch tests --watch CONTRIBUTING.rst --port 8002
 
-docs: docs-clean 									## Dump the existing built docs and rebuild them
+docs: docs-clean ## Dump the existing built docs and rebuild them
 	@echo "=> Building documentation"
 	@$(UV) run sphinx-build -M html docs docs/_build/ -E -a -j auto --keep-going
 
 # =============================================================================
 # Database
 # =============================================================================
-migrations:       ## Generate database migrations
+migrations: ## Generate database migrations
 	@echo "ATTENTION: This operation will create a new database migration for any defined models changes."
 	@while [ -z "$$MIGRATION_MESSAGE" ]; do read -r -p "Migration message: " MIGRATION_MESSAGE; done ;
 	@$(UV) run app database make-migrations --autogenerate -m "$${MIGRATION_MESSAGE}"
 
 .PHONY: migrate
-migrate:          ## Apply database migrations
+migrate: ## Apply database migrations
 	@echo "ATTENTION: Will apply all database migrations."
 	@$(UV) run app database upgrade --no-prompt
 
@@ -155,11 +185,11 @@ destroy: ## Destroy the virtual environment
 run-dev-bot: ## Run the bot in dev mode
 	@$(UV) run app run-bot
 
-run-dev-server: ## Run the app in dev mode
+run-dev-server: up-container ## Run the app in dev mode
 	@$(UV) run app run-web --http-workers 1 --reload
 
 run-dev-frontend: ## Run the app frontend in dev mode
 	@$(UV) run tailwindcss -i byte_bot/server/domain/web/resources/input.css -o byte_bot/server/domain/web/resources/style.css --watch
 
-run-dev: ## Run the bot, web, and front end in dev mode
+run-dev: up-container ## Run the bot, web, and front end in dev mode
 	@$(UV) run app run-all --http-workers 1 -d -v --reload

byte_bot/__init__.py

@@ -11,10 +11,10 @@
 __all__ = (
     "__version__",
     "app",
-    "cli",
-    "utils",
     "byte",
+    "cli",
     "server",
+    "utils",
 )
 
 rich_tracebacks(

byte_bot/__metadata__.py

@@ -4,7 +4,7 @@
 
 import importlib.metadata
 
-__all__ = ("__version__", "__project__")
+__all__ = ("__project__", "__version__")
 
 __version__ = importlib.metadata.version("byte-bot")
 """Version of the app."""

byte_bot/byte/bot.py

@@ -90,17 +90,18 @@ async def on_command_error(self, ctx: Context, error: CommandError) -> None:
             ctx: Context object.
             error: Error object.
         """
-        err = error.original if hasattr(error, "original") else error
+        err = getattr(error, "original", error)
         if isinstance(err, Forbidden | NotFound):
             return
 
         embed = discord.Embed(title="Command Error", description=str(error), color=discord.Color.red())
-        embed.set_thumbnail(url=ctx.author.avatar.url)
+        if ctx.author.avatar:
+            embed.set_thumbnail(url=ctx.author.avatar.url)
         embed.add_field(name="Command", value=ctx.command)
         embed.add_field(name="Message", value=ctx.message.content)
-        embed.add_field(name="Channel", value=ctx.channel.mention)
+        embed.add_field(name="Channel", value=getattr(ctx.channel, "mention", str(ctx.channel)))
         embed.add_field(name="Author", value=ctx.author.mention)
-        embed.add_field(name="Guild", value=ctx.guild.name)
+        embed.add_field(name="Guild", value=ctx.guild.name if ctx.guild else "DM")
         embed.add_field(name="Location", value=f"[Jump]({ctx.message.jump_url})")
         embed.set_footer(text=f"Time: {ctx.message.created_at.strftime('%Y-%m-%d %H:%M:%S')}")
         await ctx.send(embed=embed, ephemeral=True)
@@ -132,7 +133,11 @@ async def on_guild_join(self, guild: discord.Guild) -> None:
             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)
+                logger.error(
+                    "%s joined guild '%s' but was not added to database",
+                    self.user.name if self.user else "Bot",
+                    guild.name,
+                )
 
 
 def run_bot() -> None:

byte_bot/byte/lib/__init__.py

@@ -3,8 +3,8 @@
 from byte_bot.byte.lib import common, log, settings, utils
 
 __all__ = [
+    "common",
+    "log",
     "settings",
     "utils",
-    "log",
-    "common",
 ]

byte_bot/byte/lib/log.py

@@ -13,8 +13,8 @@
 from byte_bot.byte.lib import settings
 
 __all__ = [
-    "setup_logging",
     "get_logger",
+    "setup_logging",
 ]
 
 install(show_locals=True, theme="dracula")

byte_bot/byte/lib/settings.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import os
-from pathlib import Path  # noqa: TCH003
+from pathlib import Path  # noqa: TC003
 from typing import Final
 
 from dotenv import load_dotenv
@@ -14,12 +14,12 @@
 from byte_bot.__metadata__ import __version__ as version
 
 __all__ = [
-    "discord",
-    "log",
-    "project",
     "DiscordSettings",
     "LogSettings",
     "ProjectSettings",
+    "discord",
+    "log",
+    "project",
 ]
 
 load_dotenv()
@@ -44,13 +44,13 @@ class DiscordSettings(BaseSettings):
     """Discord User ID for development."""
     PLUGINS_LOC: Path = PLUGINS_DIR
     """Base Path to plugins directory."""
-    PLUGINS_DIRS: list[Path] = [f"{PLUGINS_DIR}"]
+    PLUGINS_DIRS: list[Path] = [PLUGINS_DIR]
     """Directories to search for plugins."""
     PRESENCE_URL: str = ""
 
     @field_validator("COMMAND_PREFIX")
     @classmethod
-    def assemble_command_prefix(cls, value: str) -> list[str]:
+    def assemble_command_prefix(cls, value: list[str]) -> list[str]:
         """Assembles the bot command prefix based on the environment.
 
         Args:
@@ -66,7 +66,9 @@ def assemble_command_prefix(cls, value: str) -> list[str]:
         }
         environment = os.getenv("ENVIRONMENT", "dev")
         # Add env specific command prefix in addition to the default "!"
-        value.append(os.getenv("COMMAND_PREFIX", env_urls[environment]))
+        env_prefix = os.getenv("COMMAND_PREFIX", env_urls[environment])
+        if env_prefix not in value:
+            value.append(env_prefix)
         return value
 
     @field_validator("PRESENCE_URL")
@@ -125,13 +127,11 @@ class ProjectSettings(BaseSettings):
 
 
 # noinspection PyShadowingNames
-def load_settings() -> (
-    tuple[
-        DiscordSettings,
-        LogSettings,
-        ProjectSettings,
-    ]
-):
+def load_settings() -> tuple[
+    DiscordSettings,
+    LogSettings,
+    ProjectSettings,
+]:
     """Load Settings file.
 
     Returns:

byte_bot/byte/lib/utils.py

@@ -26,27 +26,27 @@
     from discord.ext.commands._types import Check
 
 __all__ = (
+    "PEP",
     "BaseRuffRule",
-    "RuffRule",
     "FormattedRuffRule",
-    "PEP",
+    "RuffRule",
+    "chunk_sequence",
+    "format_ruff_rule",
     "is_byte_dev",
     "linker",
-    "mention_user",
-    "mention_user_nickname",
     "mention_channel",
-    "mention_role",
-    "mention_slash_command",
     "mention_custom_emoji",
     "mention_custom_emoji_animated",
-    "mention_timestamp",
     "mention_guild_navigation",
-    "format_ruff_rule",
-    "query_all_ruff_rules",
-    "run_ruff_format",
+    "mention_role",
+    "mention_slash_command",
+    "mention_timestamp",
+    "mention_user",
+    "mention_user_nickname",
     "paste",
-    "chunk_sequence",
     "query_all_peps",
+    "query_all_ruff_rules",
+    "run_ruff_format",
 )
 
 _T = TypeVar("_T")