✨ Add support for env variables

Author: Paillat-dev

main.py

@@ -14,19 +14,20 @@ def check_module(module_name: str) -> bool:
 def main():
     bot = discord.Bot(intents=discord.Intents.default())
 
-    logger = get_logger(name="Main")
+    logger = get_logger(name="main")
     logger.info("Starting bot")
 
     for extension, its_config in config["extensions"].items():
         if its_config["enabled"]:
+            _logger = get_logger(name=extension)
             if check_module(f"src.extensions.{extension}"):
                 logger.info(f"Loading extension {extension}")
                 module = importlib.import_module(f"src.extensions.{extension}")
-                module.setup(bot, logger, its_config)
+                module.setup(bot, _logger, its_config)
             elif check_module(extension):
                 logger.info(f"Loading extension {extension}")
                 module = importlib.import_module(extension)
-                module.setup(bot, logger, its_config)
+                module.setup(bot, _logger, its_config)
             else:
                 logger.error(f"Extension {extension} not found")
 

pyproject.toml

@@ -13,6 +13,7 @@ py-cord = "^2.5.0"
 aiohttp = "^3.9.5"
 pyyaml = "^6.0.1"
 python-dotenv = "^1.0.1"
+orjson = "^3.10.3"
 
 
 [tool.poetry.group.dev.dependencies]

readme.md

@@ -34,7 +34,8 @@ poetry install
 
 ## Setup
 
-1. Set up the `config.yml` file with your bot token and desired extensions. Here's an example configuration:
+### Yaml Configuration
+You can set up the `config.yml` file with your bot token and desired extensions. Here's an example configuration:
 
 ```yaml
 extensions:
@@ -49,6 +50,15 @@ logging:
   level: INFO
 ```
 
+### Environment Variables
+Alternatively, you can set the bot token and other configuration options using environment variables. You can set any variable as you would in the `config.yml` file, but with the `BOTKIT__` prefix, and `__` to separate nested keys. To set lists, use regular json syntax.
+```env
+BOTKIT__bot__token=your_bot_token
+BOTKIT__extensions__topgg__enabled=false
+BOTKIT__extensions__ping__enabled=true
+BOTKIT__logging__level=INFO
+```
+
 ## Default Extensions
 
 ### Ping Extension
@@ -78,7 +88,7 @@ def setup(bot: discord.Bot, logger: logging.Logger, config: dict):
 
 - `bot`: The Discord bot instance.
 - `logger`: A logger instance for logging messages.
-- `config`: The configuration dictionary for the extension from the `config.yml` file.
+- `config`: The configuration dictionary for the extension from the `config.yml` file. All config keys will always be lowercased for compatibility with environment variables.
 
 ## Contributing
 

src/config/bot_config.py

@@ -1,15 +1,66 @@
 import yaml
 import os
+import orjson
 
+from dotenv import load_dotenv
 from typing import Any
 
+load_dotenv()
+
+SPLIT: str = "_"
+
+
+def load_from_env() -> dict[str, dict[str, Any]]:
+
+    _config = {}
+    values = {k: v for k, v in os.environ.items() if k.startswith(f"BOTKIT{SPLIT}")}
+    values = {k[len(f"BOTKIT{SPLIT}") :]: v for k, v in values.items()}
+    for key, value in values.items():
+        for i, part in enumerate(key.split(SPLIT)):
+            part = part.lower()
+            if i == 0:
+                if part not in _config:
+                    _config[part] = {}
+                current = _config[part]
+            elif i == len(key.split(SPLIT)) - 1:
+                current[part] = value
+            else:
+                if part not in current:
+                    current[part] = {}
+                elif not isinstance(current[part], dict):
+                    raise ValueError(f"Key {key} in environment must be a leaf")
+                current = current[part]
+
+    return load_json_recursive(_config)
+
+
+def load_json_recursive(data: dict[str, Any]) -> dict[str, Any]:
+    for key, value in data.items():
+        if isinstance(value, dict):
+            data[key] = load_json_recursive(value)
+        elif isinstance(value, str):
+            if value.lower() == "true":
+                data[key] = True
+            elif value.lower() == "false":
+                data[key] = False
+            else:
+                try:
+                    data[key] = orjson.loads(value)
+                except orjson.JSONDecodeError:
+                    pass
+    return data
+
+
+path = None
 if os.path.exists("config.yaml"):
     path = "config.yaml"
 elif os.path.exists("config.yml"):
     path = "config.yml"
-else:
-    raise FileNotFoundError("Configuration file not found")
 
-# noinspection PyArgumentEqualDefault
-with open(path, "r", encoding="utf-8") as f:
-    config: dict[str, dict[str, Any]] = yaml.safe_load(f)
+
+if path:
+    # noinspection PyArgumentEqualDefault
+    with open(path, "r", encoding="utf-8") as f:
+        config: dict[str, dict[str, Any]] = yaml.safe_load(f)
+else:
+    config: dict[str, dict[str, Any]] = load_from_env()