Add fetching of READMEs to final repos

.gitignore

@@ -3,6 +3,8 @@ output/
 md-failed.txt
 github_links.txt
 awesome-repos.txt
+awesome-repos.parquet
+
 
 
 # Byte-compiled / optimized / DLL files

data_collection_utils/awesome_final_repos.py

@@ -42,6 +42,7 @@ from github_api_utils import (
     fetch_repo_description,
     fetch_repo_readme_markdown,
 )
+from tqdm.auto import tqdm
 
 load_dotenv()
 
@@ -233,18 +234,31 @@ async def crawl_awesome_final_entries(
                     queue.append((o, r, depth + 1))
             else:
                 if cu not in results:
+                    # Track the depth at which we found this repo so we can prefer the most specific (deepest) source list
                     results[cu] = {
                         "name": e["name"],
                         "link": cu,
                         "description": e["description"],
-                        "source_repo": f"{owner}/{repo}",
+                        "source_repo": f"{repo}",
+                        "source_depth": depth,
                     }
                 else:
-                    # Prefer keeping the first occurrence; if existing description is empty and new is not, update
+                    # Prefer the deepest (most specific) source list as the source_repo
+                    prev_depth = results[cu].get("source_depth")
+                    if prev_depth is None or depth > prev_depth:
+                        results[cu]["source_repo"] = f"{repo}"
+                        results[cu]["source_depth"] = depth
+                    # If existing description is empty and new is not, update
                     if not results[cu]["description"] and e["description"]:
                         results[cu]["description"] = e["description"]
 
-    return list(results.values())
+    # Drop internal helper key before returning
+    out: List[Dict[str, str]] = []
+    for v in results.values():
+        if "source_depth" in v:
+            v = {k: v[k] for k in v.keys() if k != "source_depth"}
+        out.append(v)
+    return out
 
 
 async def fetch_repo_stars(
@@ -276,6 +290,26 @@ async def enrich_with_stars(
     await asyncio.gather(*(one(r) for r in rows))
 
 
+async def enrich_with_readme_preview(
+    session: aiohttp.ClientSession,
+    rows: List[Dict[str, str]],
+    concurrency: int,
+    max_chars: int,
+) -> None:
+    sem = asyncio.Semaphore(concurrency if concurrency and concurrency > 0 else 10)
+
+    async def one(row: Dict[str, str]):
+        async with sem:
+            owner, repo = parse_owner_repo(row["link"])  # link is canonical
+            md = await fetch_repo_readme_markdown(session, owner, repo)
+            if md is not None:
+                row["readme_preview"] = md[:max_chars]
+
+    tasks = [asyncio.create_task(one(r)) for r in rows]
+    for fut in tqdm(asyncio.as_completed(tasks), total=len(tasks), desc="README enrichment"):
+        await fut
+
+
 def _desc_is_missing(desc: Optional[str]) -> bool:
     if desc is None:
         return True
@@ -297,7 +331,9 @@ async def enrich_missing_descriptions(
             if desc:
                 row["description"] = desc
 
-    await asyncio.gather(*(one(r) for r in rows))
+    tasks = [asyncio.create_task(one(r)) for r in rows]
+    for fut in tqdm(asyncio.as_completed(tasks), total=len(tasks), desc="Description enrichment"):
+        await fut
 
 
 def main() -> None:
@@ -338,6 +374,18 @@ def main() -> None:
         default=cfg.get("cache_dir", "output/awesome_parse_cache"),
         help="Cache directory for README content",
     )
+    ap.add_argument(
+        "--fetch-readme-preview",
+        action="store_true",
+        default=cfg.get("fetch_readme_preview", False),
+        help="When set, fetch first N characters of README for each final repo and include as readme_preview",
+    )
+    ap.add_argument(
+        "--readme-preview-chars",
+        type=int,
+        default=cfg.get("readme_preview_chars", 1000),
+        help="Number of characters from README to include in readme_preview",
+    )
     # YAML-configurable flag to fetch stars for each parsed repo
     fetch_stars_value = bool(cfg.get("fetch_stars", False))
     args = ap.parse_args()
@@ -365,6 +413,14 @@ def main() -> None:
             if rows:
                 print("Filling missing descriptions from GitHub repo metadata...")
                 await enrich_missing_descriptions(session, rows, args.workers)
+            # Optionally fetch README preview for each repo
+            if getattr(args, "fetch_readme_preview", False) and rows:
+                print(
+                    f"Fetching README previews (first {args.readme_preview_chars} chars) for {len(rows)} repos..."
+                )
+                await enrich_with_readme_preview(
+                    session, rows, args.workers, args.readme_preview_chars
+                )
             out_parquet = output_dir / "awesome-repos.parquet"
             output_dir.mkdir(parents=True, exist_ok=True)
             # include stars column if present
@@ -378,6 +434,7 @@ def main() -> None:
                     "description",
                     "source_repo",
                     "stars",
+                    "readme_preview",
                 ]
                 if c in df.columns
             ]

data_collection_utils/awesome_scrap_config.yaml

@@ -19,4 +19,11 @@ workers: 16
 
 # Optionally fetch stargazers_count for each parsed repo (extra API requests)
 # Set to true to include a 'stars' column in awesome-repos.parquet
-fetch_stars: false
+fetch_stars: false
+
+# Optionally fetch README preview for each parsed repo (extra API requests)
+# Set to true to include a 'readme_preview' column in awesome-repos.parquet
+fetch_readme_preview: false
+
+# Number of characters from README to include in readme_preview
+readme_preview_chars: 1000