more automatization + fix issues

Author: codewithme-py

.github/workflows/update-readme.yml

@@ -7,7 +7,42 @@ on:
       - 'solutions/*.py'
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: pip install -e .[dev]
+
+      - name: Run Ruff linter
+        run: ruff check .
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: pip install -e .[dev]
+
+      - name: Run tests
+        run: pytest
+
   update-readme:
+    needs: [lint, test]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -16,14 +51,13 @@ jobs:
           token: ${{ secrets.GH_PAT }}
           persist-credentials: true
 
-      - name: Set up Python
+      - name: Set up Python 3.10
         uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 
       - name: Install dependencies
-        run: |
-          pip install -r requirements-dev.txt
+        run: pip install -e .[dev]
 
       - name: Generate README
         run: python scripts/update_readme.py
@@ -35,11 +69,7 @@ jobs:
           git add README.md
           if ! git diff --cached --quiet; then
             git commit -m "chore: auto-update README with latest solutions"
-            # Добавляем токен в URL для пуша
-            git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
             git push
           else
             echo "No changes to README."
-          fi
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+          fi

README.md

@@ -3,18 +3,106 @@
 My clean, typed, and tested solutions to LeetCode problems (Python 3.10+).
 
 <!-- START_STATS -->
-- ✅ Solved: 4
-- 🟢 Easy: 3
-- 🟡 Medium: 1
-- 🔴 Hard: 0
+
 <!-- END_STATS -->
 
 <!-- START_TABLE -->
 ## Problems
 | # | Title | Difficulty | Solution |
 |---|-------|------------|----------|
-| 1 | [Two Sum](https://leetcode.com/problems/two-sum/) | Easy | [`two_sum_0001.py`](solutions/two_sum_0001.py) |
-| 9 | [Palindrome Number](https://leetcode.com/problems/palindrome-number/) | Easy | [`palindrome_number_0009.py`](solutions/palindrome_number_0009.py) |
-| 12 | [Integer to Roman](https://leetcode.com/problems/integer-to-roman/) | Medium | [`integer_to_roman_0012.py`](solutions/integer_to_roman_0012.py) |
-| 13 | [Roman to Integer](https://leetcode.com/problems/roman-to-integer/) | Easy | [`roman_to_integer_0013.py`](solutions/roman_to_integer_0013.py) |
-<!-- END_TABLE -->
+
+<!-- END_TABLE -->
+
+<hr>
+
+<details>
+<summary><b>Installation guide & description</b></summary>
+
+Этот репозиторий — не просто сборник решений, а **готовая среда для практики LeetCode** с автоматизацией и профессиональным workflow.
+
+### 💡 Что получает клонировавший:
+- ✅ Все решения на **Python ^3.10** с type hints  
+- ✅ Тесты для каждой задачи (`pytest`)  
+- ✅ Автоматическая проверка стиля (`ruff`)  
+- ✅ Автообновляемый `README.md` с прогрессом и ссылками  
+- ✅ Готовая CI/CD-настройка через GitHub Actions  
+- ✅ Чёткая структура: `solutions/`, `tests/`, `scripts/`
+
+⚠️ Для работы скрипта обновления README требуется интернет (запрос к LeetCode 'API' при первом запуске).
+
+⚠️ Именование файлов
+
+Номер задачи — 4 цифры с ведущими нулями — всегда в конце имени файла, после `_`.
+
+| Тип  | Шаблон | Обязательно? |
+|------|------|-------------|
+| Решение | {название_snake_case}_{NNNN}.py | Да (для парсинга номера) |
+| Тест | test_{название_snake_case}_{NNNN}.py | Желательно (для ясности), но достаточно test_{название_snake_case/или номер}.py |
+
+
+<hr>
+
+<details>
+<summary><i>Description (EN)</i></summary>
+
+This repo provides a production-grade setup for LeetCode practice:
+- Typed, tested Python 3.10+ solutions
+- Automated README generation with progress bars
+- Preconfigured CI (tests + linter) and CD (auto-update)
+- No manual work — just solve, commit, PR
+
+⚠️ For proper README generation, internet access is required (to query LeetCode 'API' on first run).
+
+⚠️ Naming convention
+
+The problem number — 4 digits with leading zeros — always at the end of the filename, after _.
+
+| Type | Pattern | Required? |
+|------|-------|-----------|
+| Solution | {problem_name_snake_case}_{NNNN}.py | Yes (for number parsing) |
+| Test | test_{problem_name_snake_case}_{NNNN}.py | Recommended (for clarity), but enough to have test_{problem_name_snake_case/or number}.py |
+</details>
+
+<hr>
+
+### 🛠 Установка
+
+#### 1. Клонируй репо
+```bash
+git clone https://github.com/codewithme-py/LeetCode_solutions.git
+```
+```bash
+cd LeetCode_solutions
+```
+
+#### 2. Создай и активируй виртуальное окружение
+```bash
+python -m venv .venv
+```
+Linux/Mac
+```bash
+source .venv/bin/activate
+```
+или на Windows
+```bash
+source .venv\Scripts\activate
+```
+
+#### 3. Установи зависимости
+```bash
+pip install -e .[dev]
+```
+
+#### 4. Запусти тесты (проверь, что всё работает)
+```bash
+pytest && ruff check .
+```
+#### 5. Создай токен GitHub и добавь его в Secrets репозитория
+1) https://github.com/settings/tokens → перейди по ссылке
+2) Generate new token (classic) → Note: `What’s this token for?` → Expiration: `your choice` → Scopes: `repo`+`workflow` → Generate token → Скопируй токен
+3) Repo LeetCode_solutions Settings → Secrets and variables → Actions → New repository secret с именем `GH_PAT` → Вставь токен → Add secret
+
+#### 6. Создавай новую feat/ветку → Решай новую задачу → делай push → PR → merge в main → CI/CD сделает всё остальное автоматически!
+1) Удаление веток опционально (в истории коммитов сохраняется вся инфа)
+</details>
+<hr>

pyproject.toml

@@ -10,4 +10,17 @@ testpaths = ["tests"]
 python_files = ["test_*.py"]
 python_classes = ["Test*"]
 python_functions = ["test_*"]
-pythonpath = ["."]
+pythonpath = ["."]
+
+[project]
+name = "leetcode-solutions"
+requires-python = ">=3.10"
+dependencies = [
+    "requests",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "ruff",
+]

requirements-dev.txt

@@ -1,12 +1,17 @@
-# flake8: noqa
-# !/usr/bin/env python3
+# ruff: noqa: E501, UP015
+#!/usr/bin/env python3
 import json
 import re
+from collections import Counter
 from pathlib import Path
+
 import requests
 
-CACHE_FILE = 'problems_cache.json'
+SCRIPT_DIR = Path(__file__).parent
+PROJECT_ROOT = SCRIPT_DIR.parent
+CACHE_FILE = PROJECT_ROOT / 'problems_cache.json'
 GRAPHQL_URL = 'https://leetcode.com/graphql'
+LEETCODE_BASE_URL = 'https://leetcode.com/problems'
 
 
 def fetch_full_problems_cache():
@@ -63,11 +68,12 @@ def fetch_full_problems_cache():
 
 def load_problems_cache():
     """Загружает кэш или создаёт новый (полный)."""
-    if Path(CACHE_FILE).exists():
+    if CACHE_FILE.exists():
         with open(CACHE_FILE, 'r') as f:
             return json.load(f)
     return fetch_full_problems_cache()
 
+
 def extract_problem_number(file_name: str) -> int | None:
     """Извлекает номер задачи из имени файла."""
     if not file_name.endswith('.py'):
@@ -78,42 +84,70 @@ def extract_problem_number(file_name: str) -> int | None:
     return None
 
 
+def make_bar(value: int, max_val: int, width: int = 10) -> str:
+    """Генерирует текстовый прогресс-бар из эмодзи."""
+    if max_val == 0:
+        filled = 0
+    else:
+        filled = min(width, max(0, int((value / max_val) * width)))
+    return '█' * filled + '░' * (width - filled)
+
+
 def main():
-    script_dir = Path(__file__).parent
-    project_root = script_dir.parent
-    solutions_dir = project_root / 'solutions'
-    readme_path = project_root / 'README.md'
+    solutions_dir = PROJECT_ROOT / 'solutions'
+    readme_path = PROJECT_ROOT / 'README.md'
     problems = load_problems_cache()
+
     solved_files = []
-    stats = {'Easy': 0, 'Medium': 0, 'Hard': 0}
+    solved_stats = {'Easy': 0, 'Medium': 0, 'Hard': 0}
     if solutions_dir.exists():
         for f in solutions_dir.iterdir():
             if f.is_file():
                 num = extract_problem_number(f.name)
                 if num and str(num) in problems:
                     title, difficulty = problems[str(num)]
                     solved_files.append((num, title, difficulty, f.name))
-                    stats[difficulty] += 1
+                    solved_stats[difficulty] += 1
+
     solved_files.sort(key=lambda x: x[0])
-    total = sum(stats.values())
+    total_solved = sum(solved_stats.values())
+
+    counter = Counter(info[1] for info in problems.values())
+    total_stats = {
+        'Easy': counter['Easy'],
+        'Medium': counter['Medium'],
+        'Hard': counter['Hard']
+    }
+
+    easy_bar = make_bar(solved_stats['Easy'], total_stats['Easy'])
+    medium_bar = make_bar(solved_stats['Medium'], total_stats['Medium'])
+    hard_bar = make_bar(solved_stats['Hard'], total_stats['Hard'])
+
+    easy_pct = (solved_stats['Easy'] / total_stats['Easy'] * 100) if total_stats['Easy'] else 0
+    medium_pct = (solved_stats['Medium'] / total_stats['Medium'] * 100) if total_stats['Medium'] else 0
+    hard_pct = (solved_stats['Hard'] / total_stats['Hard'] * 100) if total_stats['Hard'] else 0
+
+    stats_md = (
+        f'✅ **Total**: **{total_solved}**  \n'
+        f'🟢 **Easy**: {solved_stats["Easy"]}   `{easy_bar}`   _({easy_pct:.1f}%)_  \n'
+        f'🟡 **Medium**: {solved_stats["Medium"]}   `{medium_bar}`   _({medium_pct:.1f}%)_  \n'
+        f'🔴 **Hard**: {solved_stats["Hard"]}   `{hard_bar}`   _({hard_pct:.1f}%)_'
+    )
+
     if solved_files:
         table_rows = []
         for num, title, difficulty, file_name in solved_files:
-            leetcode_url = f'https://leetcode.com/problems/{title.lower().replace(" ", "-")}/'
+            leetcode_url = f'{LEETCODE_BASE_URL}/{title.lower().replace(" ", "-")}/'
             table_rows.append(
                 f'| {num} | [{title}]({leetcode_url}) | {difficulty} | [`{file_name}`](solutions/{file_name}) |'
             )
         table_md = '\n'.join(table_rows)
     else:
         table_md = '| — | — | — | — |'
-    stats_md = (
-        f'- ✅ Solved: {total}\n'
-        f'- 🟢 Easy: {stats["Easy"]}\n'
-        f'- 🟡 Medium: {stats["Medium"]}\n'
-        f'- 🔴 Hard: {stats["Hard"]}'
-    )
+
     with open(readme_path, 'r') as f:
         content = f.read()
+
     content = re.sub(
         r'(<!-- START_STATS -->\n).*?(<!-- END_STATS -->)',
         f'<!-- START_STATS -->\n{stats_md}\n<!-- END_STATS -->',
@@ -126,9 +160,10 @@ def main():
         content,
         flags=re.DOTALL
     )
+
     with open(readme_path, 'w') as f:
         f.write(content)
-    print(f'Updated README with {total} solved problems.')
+    print(f'Updated README with {total_solved} solved problems.')
 
 
 if __name__ == '__main__':

scripts/update_readme.py

@@ -1,5 +1,13 @@
 class Solution:
     def intToRoman(self, num: int) -> str:
+        """Convert integer to Roman numeral.
+        Uses greedy algorithm with predefined value-symbol pairs including
+        subtractive forms (IV, IX, XL, XC, CD, CM).
+        Args:
+            num: Integer in [1, 3999]
+        Returns:
+            Roman numeral string
+        """
         roman_pairs = [
             (1000, 'M'), (900, 'CM'), (500, 'D'), (400, 'CD'), (100, 'C'),
             (90, 'XC'), (50, 'L'), (40, 'XL'), (10, 'X'),

solutions/integer_to_roman_0012.py

@@ -1,5 +1,13 @@
 class Solution:
     def isPalindrome(self, x: int) -> bool:
+        """Check if integer is a palindrome without string conversion.
+        Negative numbers and trailing-zero numbers (except 0) are non-palindromic.
+        Uses O(1) space by reversing half the number.
+        Args:
+            x: Integer in [-2^31, 2^31 - 1]
+        Returns:
+            True if x is palindrome, False otherwise
+        """
         if x < 0 or (x % 10 == 0 and x != 0):
             return False
         reversed_half = 0