📝 Improve docs

Author: mraniki

docs/02_config.rst

@@ -74,3 +74,10 @@ Settings.toml
 .. literalinclude:: ../examples/example.env
    :linenos:
 
+
+Config 
+=======
+
+.. automodule:: tt.config
+    :members:
+    :undoc-members:

examples/example.env

@@ -13,6 +13,7 @@
 #             TELEGRAM BOT             #
 #             on Binance               #
 ########################################
+# TT_LOGLEVEL = 'INFO'
 # TT_PLATFORM__MAIN__BOT_TOKEN = '121212121'
 # TT_PLATFORM__MAIN__BOT_CHANNEL_ID = '-1122121'
 # TT_PLATFORM__MAIN__BOT_API_ID = '1212912'

tt/config.py

@@ -21,6 +21,22 @@
 ###           ㊙️ Secrets            ###
 #######################################
 
+"""
+    In case, you use 1Password to store your settings, you can use :file:`.secrets.toml` 
+    to retrieve and store your settings from a notesPlain item.
+    more info: https://support.1password.com/command-line-getting-started/
+
+    in order to use 1Password, you need to add the following to your :file:`.env` file:
+    - OP_SERVICE_ACCOUNT_TOKEN: your 1Password service account token
+    - OP_VAULT: your 1Password vault
+    - OP_ITEM: your 1Password item
+    - OP_PATH: your one 1Password path (optional and default value `/usr/bin/op`)
+
+    The :file:`.secrets.toml` will be located in :file:`/tt/.secrets.toml` and 
+    be created by the OP client via `op read op://vault/item/notesPlain > .secrets.toml`
+
+"""
+
 if os.getenv("OP_SERVICE_ACCOUNT_TOKEN") and os.path.exists(os.getenv("OP_PATH")):
     loguru_logger.debug("Using OnePassword")
     command = [
@@ -39,6 +55,34 @@
 ###           ⚙️ Settings           ###
 #######################################
 
+"""
+ Settings are loaded via dynaconf
+ Dynaconf is a powerful and easy-to-use 
+ management library for Python.
+ It supports TOML settings file, .env file or environment variable, and other types.
+ Refer to https://github.com/dynaconf/dynaconf for more information.
+
+ More than 100 settings customizable via settings.toml or .env.
+ Most of them are predefined and you only need to 
+ update the credentials related to your exchange and chat platform
+
+ Config will load:
+    - talky default: talky_settings.toml
+    - default from library if the library support it: default_settings.toml
+    - user settings: settings.toml
+    - user secrets: .secrets.toml
+
+ Your settings should be setup in 
+ settings.toml, 
+ .secrets.toml, 
+ .env or 
+ environment variable.
+ Settings.toml or .env can be located in :file:`/app/settings.toml` 
+ or :file:`/app/.env` for docker.
+ If deployed locally, place your file in :file:`/tt/` folder.
+
+"""
+
 ROOT = os.path.dirname(__file__)
 
 settings = Dynaconf(
@@ -67,16 +111,45 @@
 ###          ⏱️ Scheduling           ###
 ########################################
 
+"""
+Scheduling is managed via asyncz lib
+More info: https://github.com/tarsil/asyncz
+
+It allows you to schedule tasks at plugin level.
+Refer to the plugin documentation 
+:file:`tt.plugins.plugin_manager`
+
+"""
+
 scheduler = AsyncIOScheduler()
 
 
 ########################################
 ###           🧐 Logging             ###
 ########################################
 
+"""
+Logging is managed via loguru
+"""
+
 
 class InterceptHandler(logging.Handler):
+    """
+    InterceptHandler is a loguru handler
+    that intercepts all log records.
+    It can be used as a replacement for logging.basicConfig()
+    """
+
     def emit(self, record):
+        """
+        Emit a log record.
+
+        Args:
+            record (logging.LogRecord): The log record to emit.
+
+        Returns:
+            None
+        """
         # Get corresponding Loguru level if it exists.
         try:
             level = logger.level(record.levelname).name
@@ -95,6 +168,12 @@ def emit(self, record):
 
 
 def loguru_setup():
+    """
+    Set up the loguru logger with custom configurations.
+
+    Returns:
+        loguru.logger: The configured loguru logger instance.
+    """
     loguru_logger.remove()
     log_filters = {
         "discord": settings.thirdparty_lib_loglevel,
@@ -113,7 +192,14 @@ def loguru_setup():
         filter=log_filters,
     )
     if settings.loglevel == "DEBUG":
-        loguru_logger.warning("DEBUG ENABLED")
+        loguru_logger.warning(
+            """
+            DEBUG ENABLED, 
+            You can disable it 
+            loglevel='INFO' in settings.toml
+            TT_LOGLEVEL=INFO in your .env or vars.
+            """
+        )
     return loguru_logger