style: add docstrings to public modules and functions

Author: monok8i

__main__.py

@@ -1,8 +1,17 @@
+"""Main entry point for the application."""
+
 from src.config.env import APP_STAGE, ENV_PATH
 from src.utils.logging import setup_logging
 
 
 def main() -> None:
+    """
+    Main entry point for the application.
+
+    Initializes logging, logs the application start,
+    current stage, and the path from which environment variables are loaded.
+    """
+
     logger = setup_logging()
     logger.info("Starting the application...")
     logger.info(f"App stage: {APP_STAGE}")

src/config/env.py

@@ -1,3 +1,5 @@
+"""Environment configuration module for loading environment variables."""
+
 import os
 from pathlib import Path
 from typing import Final

src/factory.py

@@ -0,0 +1 @@
+"""Factory module."""

src/utils/logging/config.py

@@ -1,3 +1,5 @@
+"""Configuration constants for logging setup."""
+
 from logging import INFO
 from typing import Final
 

src/utils/logging/setup.py

@@ -1,3 +1,5 @@
+"""Setup logging utilities for the application."""
+
 import logging
 import sys
 
@@ -8,6 +10,12 @@
 
 
 def setup_logging() -> logging.Logger:
+    """Set up and configure logging for the application.
+
+    Returns:
+        logging.Logger: Configured root logger.
+    """
+
     # Create a logger
     logger = logging.getLogger()
     logger.setLevel(level=DEFAULT_LOGGING_LEVEL)