Add logging configuration support and clarify documentation

Introduce `log-level` and `show-detailed-logs` options in the CLI for flexible logging configuration. Update `utils/logger.py` to align with renamed environment variables and enhance validation in `InputsCollector.py`. Revise README to include instructions for using the new logging settings.

Author: nicholasadamou

README.md

@@ -87,9 +87,10 @@ python3 main.py --mode custom --problems two-sum
 
 ## Configurations
 Squidleet uses a `LEETCODE_SESSION` cookie for authentication. Setting the `LEETCODE_SESSION` environment variable is necessary for all operations, including fetching and submitting problems.
-Squidleet uses a `LEETCODE_SESSION` cookie for authentication. You will need to set the `LEETCODE_SESSION` value as an environment variable or pass it as an argument when running the script.
 
-### Extracting `LEETCODE_SESSION`  🍪 Cookie
+### `LEETCODE_SESSION` Cookie
+
+#### Extracting `LEETCODE_SESSION`  🍪 Cookie
 
 To obtain the `LEETCODE_SESSION` cookie, follow these steps:
 
@@ -104,6 +105,19 @@ Set the cookie value as an environment variable `.env`:
 LEETCODE_SESSION=<your_session_cookie>
 ```
 
+### Logs
+
+Squidleet exposes two environment variables for logging:
+
+- `LOG_LEVEL`: Set the log level for the application. Default is `INFO`.
+- `SHOW_DETAILED_LOGS`: Enable detailed logs for debugging purposes. Default is `False`.
+
+These can also be set via arguments in the CLI:
+
+```bash
+python3 main.py --mode daily --log-level INFO --show-detailed-logs
+```
+
 ## License
 
 Squidleet is open-sourced under the MIT License. See the `LICENSE` file for more details.

services/CommandParser.py

@@ -39,5 +39,18 @@ def parse():
     parser.add_argument(
         "--open-in-browser", action="store_true", help="Open the problem in a browser"
     )
+    parser.add_argument(
+        "--log-level",
+        type=str,
+        choices=["DEBUG", "INFO", "WARN", "ERROR"],
+        help="Log level",
+        default="INFO",
+    )
+    parser.add_argument(
+        "--show-detailed-logs",
+        action="store_true",
+        help="Show timestamp and log level in logs",
+        default=False,
+    )
 
     return vars(parser.parse_args())

services/InputsCollector.py

@@ -13,6 +13,7 @@ def collect(cli_options):
     elif practice_mode == "custom":
         problems = cli_options.get("problems", "").split(",")
 
+    log_level = cli_options.get("log_level", "INFO")
     study_plan = cli_options.get("study_plan", "top-interview-150")
     language = cli_options.get("language", "python")
     time_limit = cli_options.get("time_limit", 45)
@@ -28,6 +29,7 @@ def collect(cli_options):
         "time_limit": time_limit,
         "editor": editor,
         "open_in_browser": open_in_browser,
+        "log_level": log_level,
     }
 
     _validate(inputs)
@@ -65,3 +67,9 @@ def _validate(inputs):
     valid_editors = ["default", "code", "nvim", "nano", "vim"]
     if inputs["editor"] not in valid_editors:
         raise ValueError(f"Invalid editor. Use one of: {', '.join(valid_editors)}")
+
+    valid_log_levels = ["DEBUG", "INFO", "WARN", "ERROR"]
+    if inputs["log_level"] not in valid_log_levels:
+        raise ValueError(
+            f"Invalid log level. Use one of: {', '.join(valid_log_levels)}"
+        )

utils/logger.py

@@ -25,12 +25,11 @@ class LogLevel:
 def log(message: str, level: str = LogLevel.INFO):
     # Get the configured logging level or default to INFO if not set
     configured_level = os.getenv("LOGGING_LEVEL", LogLevel.INFO)
-    show_log_details = os.getenv("SHOW_LOG_DETAILS", "False").lower() == "true"
+    show_detailed_logs = os.getenv("SHOW_DETAILED_LOGS", "False").lower() == "true"
 
     # Only log messages with a sufficient level
     if LOG_LEVEL_PRIORITY.get(level, 0) >= LOG_LEVEL_PRIORITY.get(configured_level, 0):
-        # Include timestamp/level details if SHOW_LOG_DETAILS is enabled
-        if show_log_details:
+        if show_detailed_logs:
             timestamp = datetime.datetime.now().isoformat()
             if level == LogLevel.DEBUG:
                 print(f"🐞 [{timestamp}] [{level}] {message}")