Refactor code comments for clarity and update README with Python version compatibility

Author: AlexTkDev

README.md

@@ -60,20 +60,20 @@ EduPlannerBotAI/
 
 ## 🛠 Technologies Used
 
-| Component         | Purpose                                |
-|------------------|----------------------------------------|
-| Python 3.8+       | Programming language                   |
-| aiogram 3.x       | Telegram Bot Framework                 |
-| OpenAI API        | LLM for text generation                |
-| matplotlib        | Chart rendering                        |
-| fpdf              | PDF file generation                    |
-| TinyDB            | Lightweight NoSQL database             |
-| python-dotenv     | Environment variable management        |
+| Component     | Purpose                                |
+|---------------|----------------------------------------|
+| Python 3.10+  | Programming language                   |
+| aiogram 3.x   | Telegram Bot Framework                 |
+| OpenAI API    | LLM for text generation                |
+| matplotlib    | Chart rendering                        |
+| fpdf          | PDF file generation                    |
+| TinyDB        | Lightweight NoSQL database             |
+| python-dotenv | Environment variable management        |
 
 ## 🔧 CI/CD
 
 - GitHub Actions workflow for Pylint analysis
-- Python version compatibility: 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
+- Python version compatibility: 3.10, 3.11, 3.12, 3.13
 - Custom `.pylintrc` configuration
 
 ## 🤝 Collaboration

bot.py

@@ -9,7 +9,7 @@
 from config import TOKEN
 from handlers import start, planner
 
-# Создаем необходимые директории
+# Create necessary directories
 os.makedirs("plans", exist_ok=True)
 os.makedirs("fonts", exist_ok=True)
 

services/db.py

@@ -2,5 +2,6 @@
 
 db = TinyDB("db.json")
 
+
 def save_user_plan(user_id: int, plan: list):
     db.insert({"user_id": user_id, "plan": plan})

services/llm.py

@@ -3,15 +3,15 @@
 from openai import OpenAI, RateLimitError, APIError, OpenAIError
 from config import OPENAI_API_KEY
 
-# Настройка логгера
+# Configure logging
 logger = logging.getLogger(__name__)
 
 # Initialize client
 client = OpenAI(api_key=OPENAI_API_KEY) if OPENAI_API_KEY else None
 
 # Max retries and delay between retries
 MAX_RETRIES = 3
-RETRY_DELAY = 5  # Увеличиваем задержку между попытками
+RETRY_DELAY = 5  # Icrease delay for each retry
 
 
 # Локальный генератор
@@ -61,7 +61,7 @@ async def generate_study_plan(topic: str) -> list:
         except RateLimitError as e:
             logger.warning("Rate limit error: %s. Retrying in %s seconds...",
                            str(e), RETRY_DELAY * (attempt + 1))
-            await asyncio.sleep(RETRY_DELAY * (attempt + 1))  # Экспоненциальная задержка
+            await asyncio.sleep(RETRY_DELAY * (attempt + 1))  # Exponential backoff
 
         except (APIError, OpenAIError) as e:
             logger.error("OpenAI API error: %s", str(e))
@@ -72,6 +72,6 @@ async def generate_study_plan(topic: str) -> list:
             logger.error("Unexpected error: %s", str(e))
             return generate_local_plan(topic)
 
-    # Если все попытки исчерпаны, используем локальный генератор
+    # If all attempts fail, fallback to local generator
     logger.warning("All OpenAI API attempts failed, using local generator")
     return generate_local_plan(topic)

services/pdf.py

@@ -9,7 +9,7 @@ def save_plan_to_pdf(plan_lines: list[str], user_id: int) -> str:
 
     filename = f"plans/plan_{user_id}.pdf"
 
-    # Создаем простой PDF без кастомных шрифтов, которые могут отсутствовать
+    # Create a PDF object
     pdf = FPDF()
     pdf.add_page()
 

services/reminders.py

@@ -1,5 +1,6 @@
 import asyncio
 
+
 async def schedule_reminders(user_id: int, plan: list):
     # Emulate scheduling reminders
     for i, task in enumerate(plan, start=1):