feat: adjust settings to use guild configs

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - name: Install Pre-Commit
         run: python -m pip install pre-commit && pre-commit install
@@ -34,7 +34,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.11"]
+        python-version: ["3.12"]
     timeout-minutes: 15
     defaults:
       run:
@@ -73,12 +73,12 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - uses: pdm-project/setup-pdm@v3
         name: Set up PDM
         with:
-          python-version: "3.11"
+          python-version: "3.12"
           allow-python-prereleases: true
           cache: true
 

.github/workflows/docs.yml

@@ -22,12 +22,12 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - uses: pdm-project/setup-pdm@v3
         name: Set up PDM
         with:
-          python-version: "3.11"
+          python-version: "3.12"
           allow-python-prereleases: true
           cache: true
 

.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
@@ -18,7 +18,7 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.2.2"
+    rev: "v0.3.2"
     hooks:
       - id: ruff
         args: ["--fix"]
@@ -88,7 +88,7 @@ repos:
   #             discord-py,
   #           ]
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.351
+    rev: v1.1.353
     hooks:
       - id: pyright
         additional_dependencies:
@@ -142,6 +142,7 @@ repos:
             asyncpg-stubs,
             polyfactory,
             discord-py,
+            types-python-dateutil,
           ]
   - repo: https://github.com/sphinx-contrib/sphinx-lint
     rev: "v0.9.1"

.tool-versions

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

Makefile

@@ -51,6 +51,34 @@ install: ## Install all dependencies
 	@command -v $(PDM) > /dev/null || (echo "PDM not found. Installing..." && $(MAKE) install-pdm)
 	$(MAKE) install-pre-commit
 
+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
 # =============================================================================

docs/byte/api/lib/common.rst

@@ -4,5 +4,14 @@ common
 
 Common functions and classes used by the other modules.
 
-.. automodule:: src.byte.lib.common
+.. automodule:: src.byte.lib.common.assets
+     :members:
+
+.. automodule:: src.byte.lib.common.colors
+     :members:
+
+.. automodule:: src.byte.lib.common.guilds
+     :members:
+
+.. automodule:: src.byte.lib.common.links
      :members:

docs/byte/api/lib/logging.rst

@@ -4,5 +4,5 @@ logging
 
 Logging configuration for Byte
 
-.. automodule:: src.byte.lib.logging
+.. automodule:: src.byte.lib.log
      :members:

docs/byte/api/plugins/index.rst

@@ -14,5 +14,5 @@ This includes things like commands, event handlers, and other features.
     events
     general
     github
-    guild
     testing
+    python

docs/byte/api/plugins/python.rst

@@ -0,0 +1,6 @@
+======
+python
+======
+
+.. automodule:: src.byte.plugins.python
+   :members:

docs/byte/api/views/abstract.rst

@@ -0,0 +1,8 @@
+========
+abstract
+========
+
+Abstract views to be inherited by other views.
+
+.. automodule:: src.byte.views.abstract_views
+     :members:

docs/byte/api/views/astral.rst

@@ -0,0 +1,8 @@
+======
+astral
+======
+
+Astral Inc. views, for things like Ruff embeds
+
+.. automodule:: src.byte.views.astral
+     :members:

docs/byte/api/views/index.rst

@@ -10,3 +10,6 @@ components for your bot.
     :caption: Views
 
     forums
+    astral
+    python
+    abstract

docs/byte/api/views/python.rst

@@ -0,0 +1,8 @@
+======
+python
+======
+
+Python views for things like PEP embeds.
+
+.. automodule:: src.byte.views.python
+     :members:

docs/byte/usage/byte.rst

@@ -0,0 +1,18 @@
+==========
+About Byte
+==========
+
+The Discord side of Byte is utilizing the `discord.py <https://discordpy.readthedocs.io/en/latest/>`_. framework.
+
+The structure of Byte is not too complex. There exists a ``bot.py`` file containing the main
+:ref:`Byte` bot class, which includes some on-start utilities like loading cogs and ingesting
+new guilds as they join into the database. The class is called via the :func:`run_bot` function
+to start the bot.
+
+The structure of Byte is not dissimilar to the structure of the server side; it has a ``lib/``
+directory for common backend functionality like utilities, logging, and settings, a ``plugings/``
+directory for the cogs, and a ``views/`` directory for the UI components inside of Discord.
+
+For example, any functionality related to `Astral <https://astral.sh/>`_ is located in the
+``plugins/astral/`` directory, such as ``ruff`` embeds, and it's related views are located in
+``views/astral/``.

docs/byte/usage/index.rst

@@ -1,5 +1,10 @@
+=====
 Usage
 =====
 
 .. toctree::
     :titlesonly:
+    :caption: Byte Usage Documentation
+
+    byte
+    starting

docs/byte/usage/starting.rst

@@ -0,0 +1,5 @@
+=============
+Starting Byte
+=============
+
+.. todo:: This section needs to be written.

docs/conf.py

@@ -1,4 +1,5 @@
 """Sphinx configuration."""
+
 from __future__ import annotations
 
 import importlib.metadata

docs/web/api/domain/db/models.rst

@@ -13,7 +13,7 @@ API Reference
 Model Reference
 ---------------
 
-.. sqla-model:: server.domain.db.models.GuildConfig
+.. sqla-model:: server.domain.db.models.Guild
 
 .. sqla-model:: server.domain.db.models.GitHubConfig
 

docs/web/api/domain/github/helpers.rst

@@ -0,0 +1,8 @@
+=======
+helpers
+=======
+
+Helper functions for the GitHub domain.
+
+.. automodule:: src.server.domain.github.helpers
+    :members:

docs/web/api/domain/github/index.rst

@@ -0,0 +1,11 @@
+======
+github
+======
+
+.. toctree::
+    :titlesonly:
+    :caption: GitHub Domain API Reference
+    :glob:
+    :hidden:
+
+    *

docs/web/api/domain/guilds/controllers.rst

@@ -0,0 +1,8 @@
+===========
+controllers
+===========
+
+Controllers for the guilds domain.
+
+.. automodule:: src.server.domain.guilds.controllers
+    :members:

docs/web/api/domain/guilds/dependencies.rst

@@ -0,0 +1,8 @@
+============
+dependencies
+============
+
+Dependencies for the guilds domain.
+
+.. automodule:: src.server.domain.guilds.dependencies
+    :members:

docs/web/api/domain/guilds/helpers.rst

@@ -0,0 +1,8 @@
+=======
+helpers
+=======
+
+Helper functions for the guilds domain.
+
+.. automodule:: src.server.domain.guilds.helpers
+    :members:

docs/web/api/domain/guilds/index.rst

@@ -0,0 +1,11 @@
+======
+guilds
+======
+
+.. toctree::
+    :titlesonly:
+    :caption: Guild Domain API Reference
+    :glob:
+    :hidden:
+
+    *

docs/web/api/domain/guilds/schemas.rst

@@ -0,0 +1,8 @@
+=======
+schemas
+=======
+
+Schemas for the system domain.
+
+.. automodule:: src.server.domain.guilds.schemas
+    :members:

docs/web/api/domain/guilds/services.rst

@@ -0,0 +1,8 @@
+========
+services
+========
+
+Service declaration for the guilds domain.
+
+.. automodule:: src.server.domain.guilds.services
+    :members:

docs/web/api/domain/guilds/urls.rst

@@ -0,0 +1,8 @@
+====
+urls
+====
+
+URL declarations for the guilds domain routes.
+
+.. automodule:: src.server.domain.guilds.urls
+    :members:

docs/web/api/domain/index.rst

@@ -11,5 +11,7 @@ domain
     init
     urls
     system/index
+    guilds/index
+    github/index
     web/index
     db/index

docs/web/api/domain/system/dtos.rst

@@ -0,0 +1,8 @@
+====
+dtos
+====
+
+DTOs for the system domain.
+
+.. automodule:: src.server.domain.system.dtos
+    :members:

docs/web/api/domain/system/helpers.rst

@@ -0,0 +1,8 @@
+=======
+helpers
+=======
+
+Helper functions for the system domain.
+
+.. automodule:: src.server.domain.system.helpers
+    :members:

docs/web/api/lib/constants.rst

@@ -0,0 +1,6 @@
+=========
+constants
+=========
+
+.. automodule:: src.server.lib.constants
+     :members:

docs/web/api/lib/dependencies.rst

@@ -0,0 +1,8 @@
+============
+dependencies
+============
+
+Dependency management
+
+.. automodule:: src.server.lib.dependencies
+     :members:

docs/web/api/lib/dtos.rst

@@ -0,0 +1,10 @@
+====
+dtos
+====
+
+DTOs for the server.
+
+
+.. automodule:: src.server.lib.dto
+    :members:
+    :noindex: