feat: add readme automation, with tests

Author: arnav-on-code

github_sync/readme.py

@@ -28,7 +28,6 @@ def generate(self, stats) -> Path:
 
         latest = stats.get("last_problem")
 
-        # ---------- Languages ----------
         language_lines = []
 
         for language, count in sorted(
@@ -40,7 +39,17 @@ def generate(self, stats) -> Path:
 
         languages = "\n".join(language_lines)
 
-        # ---------- Latest Problem ----------
+        recent = ""
+
+        for problem in stats.get(
+            "recent_problems",
+            [],
+        ):
+            recent += (
+                f'- {problem["id"]} '
+                f'{problem["title"]}\n'
+            )
+
         if latest:
             latest_problem = f"""
 | Field | Value |
@@ -83,6 +92,12 @@ def generate(self, stats) -> Path:
 
 {languages}
 
+## 📚 Recent Accepted Problems
+
+{recent}
+
+---
+
 ✨ Features
 Automatic LeetCode synchronization
 Automatic Git commits

github_sync/statistics.py

@@ -26,6 +26,7 @@ def _create_default(self):
             "medium": 0,
             "hard": 0,
             "languages": {},
+            "recent_problems": [],
             "last_problem": None,
             "last_sync": None,
         }
@@ -61,7 +62,7 @@ def save(self, stats):
 
     def update(self, profile, detail):
         """
-        Update statistics using latest profile and submission.
+        Update repository statistics.
         """
 
         stats = self.load()
@@ -76,6 +77,7 @@ def update(self, profile, detail):
         stats["medium"] = solved.get("Medium", 0)
         stats["hard"] = solved.get("Hard", 0)
 
+
         language = detail.language_verbose
 
         languages = stats.get("languages", {})
@@ -86,15 +88,36 @@ def update(self, profile, detail):
 
         stats["languages"] = languages
 
-        stats["last_problem"] = {
+
+        latest = {
             "id": detail.question_id,
             "title": detail.title_slug.replace("-", " ").title(),
             "language": detail.language_verbose,
             "runtime": detail.runtime_display,
             "memory": detail.memory_display,
         }
 
-        stats["last_sync"] = datetime.now().isoformat()
+        stats["last_problem"] = latest
+
+
+        recent = stats.get("recent_problems", [])
+
+        recent.insert(
+            0,
+            {
+                "id": detail.question_id,
+                "title": detail.title_slug.replace("-", " ").title(),
+            },
+        )
+
+
+        stats["recent_problems"] = recent[:5]
+
+        # ---------- Last sync ----------
+
+        stats["last_sync"] = datetime.now().strftime(
+            "%Y-%m-%d %H:%M:%S"
+        )
 
         self.save(stats)
 

tests/conftest.py

@@ -15,11 +15,13 @@ def sample_submission():
 
 
 @pytest.fixture
-def sample_submission_detail():
+def sample_submission_detail(sample_detail):
     """
-    Sample submission detail.
+    Alias for backward compatibility.
     """
-
+    return sample_detail
+@pytest.fixture
+def sample_detail():
     return SubmissionDetail(
         submission_id="2051842379",
         question_id="295",
@@ -31,11 +33,13 @@ def sample_submission_detail():
         memory=41264000,
         memory_display="41.3 MB",
         status_code=10,
-        code=("class MedianFinder:\n" "    pass\n"),
+        code="print('hello')",
         timestamp=1782879665,
     )
 
 
+
+
 @pytest.fixture
 def temp_solution_dir(tmp_path):
     """

tests/test_readme.py

@@ -0,0 +1,45 @@
+from github_sync.readme import ReadmeGenerator
+
+
+def test_generate(tmp_path):
+    generator = ReadmeGenerator()
+
+    generator.readme = tmp_path / "README.md"
+
+    stats = {
+        "total": 121,
+        "easy": 63,
+        "medium": 52,
+        "hard": 6,
+        "languages": {
+            "Python3": 121,
+        },
+        "last_problem": {
+            "id": "295",
+            "title": "Find Median From Data Stream",
+            "language": "Python3",
+            "runtime": "177 ms",
+            "memory": "41.3 MB",
+        },
+        "recent_problems": [
+            {
+                "id": "295",
+                "title": "Find Median From Data Stream",
+            }
+        ],
+        "last_sync": "2026-07-02 10:00:00",
+    }
+
+    path = generator.generate(stats)
+
+    assert path.exists()
+
+    content = path.read_text(
+        encoding="utf-8"
+    )
+
+    assert "LeetCode Sync" in content
+
+    assert "Find Median From Data Stream" in content
+
+    assert "Python3" in content

tests/test_statistics.py

@@ -0,0 +1,71 @@
+import json
+
+from github_sync.statistics import StatisticsManager
+
+
+def test_create_default(tmp_path):
+    manager = StatisticsManager()
+
+    manager.stats_file = tmp_path / "stats.json"
+
+    manager._create_default()
+
+    assert manager.stats_file.exists()
+
+
+def test_load_default(tmp_path):
+    manager = StatisticsManager()
+
+    manager.stats_file = tmp_path / "stats.json"
+
+    manager._create_default()
+
+    stats = manager.load()
+
+    assert stats["total"] == 0
+    assert stats["languages"] == {}
+    assert stats["recent_problems"] == []
+
+
+def test_save(tmp_path):
+    manager = StatisticsManager()
+
+    manager.stats_file = tmp_path / "stats.json"
+
+    manager._create_default()
+
+    stats = manager.load()
+
+    stats["total"] = 100
+
+    manager.save(stats)
+
+    loaded = manager.load()
+
+    assert loaded["total"] == 100
+
+
+def test_update(sample_detail):
+    manager = StatisticsManager()
+
+    profile = {
+        "submitStatsGlobal": {
+            "acSubmissionNum": [
+                {"difficulty": "All", "count": 121},
+                {"difficulty": "Easy", "count": 63},
+                {"difficulty": "Medium", "count": 52},
+                {"difficulty": "Hard", "count": 6},
+            ]
+        }
+    }
+
+    stats = manager.update(
+        profile,
+        sample_detail,
+    )
+
+    assert stats["total"] == 121
+
+    assert stats["last_problem"]["id"] == sample_detail.question_id
+
+    assert stats["languages"]["Python3"] >= 1

tests/test_sync_manager.py

@@ -51,11 +51,7 @@ def test_sync_manager_run(
 
     manager.downloader.download = MagicMock()
 
-    manager.git.add = MagicMock()
-
-    manager.git.commit = MagicMock()
-
-    manager.git.push = MagicMock()
+    manager.git.sync = MagicMock()
 
     manager.detector.update = MagicMock()
 
@@ -69,11 +65,8 @@ def test_sync_manager_run(
 
     manager.downloader.download.assert_called_once()
 
-    manager.git.add.assert_called_once()
-
-    manager.git.commit.assert_called_once()
 
-    manager.git.push.assert_called_once()
+    manager.git.sync.assert_called_once()
 
     manager.detector.update.assert_called_once()