Added a note about a debug setting

Reviewed-on: #25

README.md

@@ -73,6 +73,34 @@ Mandatory keys to modify:
 
 After all of that you're good to go! Happy using :)
 
+## Caching
+
+Although general database access speed is fast, caching might become helpful for
+bigger servers with many bot interactions. Currently, Redis and Memcached are supported.
+
+Configuration happens through the config key `caching`.
+
+Set `caching.type` to the service of you choice ("redis" or "memcached") and then update
+the URI to access the service. It's Redis' default URI format for Redis and "address:port"
+for Memcached.
+
+Which one should I choose?
+
+| Service   | Read/write speed | Config flexibility |
+|-----------|------------------|--------------------|  
+| Redis     | High             | Very flexible      |
+| Memcached | Very high        | Basic              |
+
+> Performance difference between Redis and Memcached is generally quite low, so your setup
+> should normally depend more on the configuration flexibility than on raw speed.
+
+## Debugging
+
+There's a config key `debug` that can be set to `true` for debugging purposes.
+
+It should be set to `false` in production, otherwise log becomes very verbose and might
+contain data that shouldn't normally be logged.
+
 ## Docker [Experimental]
 
 As an experiment, Docker deployment option has been added.

classes/holo_bot.py

@@ -5,7 +5,7 @@ from libbot.pycord.classes import PycordBot
 
 from classes.cache.holo_cache_memcached import HoloCacheMemcached
 from classes.cache.holo_cache_redis import HoloCacheRedis
-from modules.cache_utils import create_cache_client
+from modules.cache_manager import create_cache_client
 
 logger: Logger = logging.getLogger(__name__)
 

modules/cache_manager.py

@@ -0,0 +1,29 @@
+from typing import Dict, Any, Literal
+
+from classes.cache.holo_cache_memcached import HoloCacheMemcached
+from classes.cache.holo_cache_redis import HoloCacheRedis
+
+
+def create_cache_client(
+    config: Dict[str, Any],
+    engine: Literal["memcached", "redis"] | None = None,
+) -> HoloCacheMemcached | HoloCacheRedis:
+    if engine not in ["memcached", "redis"] or engine is None:
+        raise KeyError(
+            f"Incorrect cache engine provided. Expected 'memcached' or 'redis', got '{engine}'"
+        )
+
+    if "cache" not in config or engine not in config["cache"]:
+        raise KeyError(
+            f"Cache configuration is invalid. Please check if all keys are set (engine: '{engine}')"
+        )
+
+    match engine:
+        case "memcached":
+            return HoloCacheMemcached.from_config(config["cache"][engine])
+        case "redis":
+            return HoloCacheRedis.from_config(config["cache"][engine])
+        case _:
+            raise KeyError(
+                f"Cache implementation for the engine '{engine}' is not present."
+            )

modules/cache_utils.py

@@ -1,37 +1,9 @@
 from copy import deepcopy
-from typing import Dict, Any, Literal
+from typing import Any
 
 from bson import ObjectId
 from ujson import dumps, loads
 
-from classes.cache.holo_cache_memcached import HoloCacheMemcached
-from classes.cache.holo_cache_redis import HoloCacheRedis
-
-
-def create_cache_client(
-    config: Dict[str, Any],
-    engine: Literal["memcached", "redis"] | None = None,
-) -> HoloCacheMemcached | HoloCacheRedis:
-    if engine not in ["memcached", "redis"] or engine is None:
-        raise KeyError(
-            f"Incorrect cache engine provided. Expected 'memcached' or 'redis', got '{engine}'"
-        )
-
-    if "cache" not in config or engine not in config["cache"]:
-        raise KeyError(
-            f"Cache configuration is invalid. Please check if all keys are set (engine: '{engine}')"
-        )
-
-    match engine:
-        case "memcached":
-            return HoloCacheMemcached.from_config(config["cache"][engine])
-        case "redis":
-            return HoloCacheRedis.from_config(config["cache"][engine])
-        case _:
-            raise KeyError(
-                f"Cache implementation for the engine '{engine}' is not present."
-            )
-
 
 def json_to_string(json_object: Any) -> str:
     json_object_copy: Any = deepcopy(json_object)