mirror of
https://github.com/wilsonfreitas/awesome-quant.git
synced 2026-07-27 20:07:50 +00:00
Wilson Freitas
5a6f90cc85
- Add site/generate.py: static site with search, filtering, sorting, dark mode - Add site/static/style.css and main.js for the new frontend - Extend parse.py: fetch CRAN published dates, PyPI release dates, and discover GitHub repos from CRAN pages as fallback data sources - Migrate from Poetry to uv (pyproject.toml + uv.lock) - Update CI workflow to use uv and generate.py pipeline - Add CONTRIBUTING.md with entry format guidelines - Add "Submit a Project" button to site nav - Update review-pr skill with all accepted entry formats - Update CLAUDE.md to reflect new architecture - Remove Quarto files (_quarto.yml, *.qmd, sync-site skill, poetry.lock) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
418 lines
15 KiB
Python
418 lines
15 KiB
Python
#!/usr/bin/env python3
|
|
"""Parse README.md and generate a static HTML site for awesome-quant.
|
|
|
|
Can run in two modes:
|
|
1. With projects.csv (produced by parse.py) — includes stars, last commit, etc.
|
|
2. Without CSV — parses README.md directly for a quick local preview.
|
|
"""
|
|
|
|
import csv
|
|
import html
|
|
import re
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
|
|
def slugify(text: str) -> str:
|
|
"""Convert text to lowercase hyphen-separated slug."""
|
|
text = text.lower().strip()
|
|
text = re.sub(r"[&/]+", "-", text)
|
|
text = re.sub(r"[^\w\s-]", "", text)
|
|
text = re.sub(r"[\s_]+", "-", text)
|
|
text = re.sub(r"-+", "-", text)
|
|
return text.strip("-")
|
|
|
|
|
|
def parse_readme(path: str) -> list[dict]:
|
|
"""Parse README.md and return a list of project entries (no API data)."""
|
|
entries = []
|
|
current_language = ""
|
|
current_category = ""
|
|
|
|
re_h2 = re.compile(r"^## (.+)$")
|
|
re_h3 = re.compile(r"^### (.+)$")
|
|
re_entry = re.compile(r"^\s*- \[(.+?)\]\((.+?)\) - (.+)$")
|
|
re_github = re.compile(r"\[GitHub\]\((https://github\.com/[\w-]+/[-\w\.]+)\)")
|
|
|
|
skip_sections = {"Languages"}
|
|
|
|
# Strip markdown badge images before parsing
|
|
re_badge = re.compile(r"\s*!\[[^\]]*\]\([^)]*\)\s*")
|
|
|
|
with open(path, "r", encoding="utf-8") as f:
|
|
for line in f:
|
|
line = re_badge.sub(" ", line).rstrip("\n")
|
|
|
|
m = re_h2.match(line)
|
|
if m:
|
|
current_language = m.group(1).strip()
|
|
current_category = ""
|
|
continue
|
|
|
|
m = re_h3.match(line)
|
|
if m:
|
|
current_category = m.group(1).strip()
|
|
continue
|
|
|
|
if current_language in skip_sections:
|
|
continue
|
|
|
|
m = re_entry.match(line)
|
|
if m:
|
|
name = m.group(1).strip()
|
|
url = m.group(2).strip()
|
|
desc = m.group(3).strip()
|
|
|
|
github_url = ""
|
|
gh_match = re_github.search(desc)
|
|
if gh_match:
|
|
github_url = gh_match.group(1)
|
|
desc = re_github.sub("", desc).rstrip(". ").rstrip() + "."
|
|
elif "github.com" in url:
|
|
github_url = url
|
|
|
|
repo = ""
|
|
if github_url:
|
|
repo_match = re.match(
|
|
r"https://github\.com/([\w-]+/[-\w\.]+)", github_url
|
|
)
|
|
if repo_match:
|
|
repo = repo_match.group(1)
|
|
|
|
is_cran = "cran.r-project.org" in url
|
|
is_pypi = "pypi.org" in url or "pypi.python.org" in url
|
|
is_commercial = current_language == "Commercial & Proprietary Services"
|
|
category = current_category or current_language
|
|
section_slug = slugify(category)
|
|
|
|
entries.append(
|
|
{
|
|
"project": name,
|
|
"language": current_language,
|
|
"category": category,
|
|
"section_slug": section_slug,
|
|
"url": url,
|
|
"description": desc,
|
|
"github": bool(github_url),
|
|
"cran": is_cran,
|
|
"pypi": is_pypi,
|
|
"commercial": is_commercial,
|
|
"github_url": github_url,
|
|
"repo": repo,
|
|
"stars": 0,
|
|
"last_commit": "",
|
|
}
|
|
)
|
|
|
|
return entries
|
|
|
|
|
|
def load_csv(path: str) -> list[dict]:
|
|
"""Load projects from CSV produced by parse.py."""
|
|
entries = []
|
|
with open(path, "r", encoding="utf-8") as f:
|
|
reader = csv.DictReader(f)
|
|
for row in reader:
|
|
# Normalize booleans
|
|
for key in ("github", "cran", "pypi", "commercial"):
|
|
row[key] = row.get(key, "").lower() in ("true", "1", "yes")
|
|
# Normalize numbers
|
|
row["stars"] = int(float(row.get("stars", 0) or 0))
|
|
# Extract github_url and repo from CSV data
|
|
repo = row.get("repo", "")
|
|
row["github_url"] = f"https://github.com/{repo}" if repo else ""
|
|
# Clean description: strip [GitHub](url) if present
|
|
desc = row.get("description", "")
|
|
desc = re.sub(
|
|
r"\s*\[GitHub\]\(https://github\.com/[\w-]+/[-\w\.]+\)\s*",
|
|
"",
|
|
desc,
|
|
)
|
|
desc = desc.rstrip(". ").rstrip()
|
|
if desc and not desc.endswith("."):
|
|
desc += "."
|
|
row["description"] = desc
|
|
entries.append(row)
|
|
return entries
|
|
|
|
|
|
def format_stars(n: int) -> str:
|
|
"""Format star count for display."""
|
|
if n >= 1000:
|
|
return f"{n / 1000:.1f}k".replace(".0k", "k")
|
|
return str(n) if n > 0 else ""
|
|
|
|
|
|
def build_tags_html(e: dict) -> str:
|
|
"""Build tag pills for an entry."""
|
|
esc = html.escape
|
|
tags = []
|
|
|
|
# Language tag
|
|
lang = e.get("language", "")
|
|
if lang and lang != "Commercial & Proprietary Services" and lang != "Related Lists":
|
|
lang_slug = slugify(lang)
|
|
tags.append(
|
|
f'<button class="tag tag-lang" data-filter-type="language" '
|
|
f'data-filter-value="{esc(lang)}">{esc(lang_slug)}</button>'
|
|
)
|
|
|
|
# Section tag
|
|
section_slug = e.get("section_slug", "")
|
|
category = e.get("category", "")
|
|
if section_slug and section_slug != slugify(lang):
|
|
tags.append(
|
|
f'<button class="tag tag-section" data-filter-type="category" '
|
|
f'data-filter-value="{esc(category)}">{esc(section_slug)}</button>'
|
|
)
|
|
|
|
# Source tags
|
|
if e.get("github"):
|
|
tags.append(
|
|
'<button class="tag tag-source tag-github" '
|
|
'data-filter-type="source" data-filter-value="github">github</button>'
|
|
)
|
|
if e.get("cran"):
|
|
tags.append(
|
|
'<button class="tag tag-source tag-cran" '
|
|
'data-filter-type="source" data-filter-value="cran">cran</button>'
|
|
)
|
|
if e.get("pypi"):
|
|
tags.append(
|
|
'<button class="tag tag-source tag-pypi" '
|
|
'data-filter-type="source" data-filter-value="pypi">pypi</button>'
|
|
)
|
|
if e.get("commercial"):
|
|
tags.append(
|
|
'<button class="tag tag-source tag-commercial" '
|
|
'data-filter-type="source" data-filter-value="commercial">commercial</button>'
|
|
)
|
|
|
|
return "\n ".join(tags)
|
|
|
|
|
|
def generate_html(entries: list[dict]) -> str:
|
|
"""Generate the full HTML page from project entries."""
|
|
languages = sorted(
|
|
set(
|
|
e["language"]
|
|
for e in entries
|
|
if e.get("language") and e["language"] != "Languages"
|
|
)
|
|
)
|
|
|
|
# Build table rows
|
|
rows = []
|
|
for i, e in enumerate(entries, 1):
|
|
esc = html.escape
|
|
name = esc(e["project"])
|
|
url = esc(e["url"])
|
|
desc = esc(e["description"])
|
|
language = esc(e.get("language", ""))
|
|
category = esc(e.get("category", ""))
|
|
github_url = esc(e.get("github_url", ""))
|
|
repo = esc(e.get("repo", ""))
|
|
stars = int(e.get("stars", 0) or 0)
|
|
last_commit = e.get("last_commit", "") or ""
|
|
is_github = e.get("github", False)
|
|
is_cran = e.get("cran", False)
|
|
is_pypi = e.get("pypi", False)
|
|
is_commercial = e.get("commercial", False)
|
|
|
|
# Stars display
|
|
stars_html = (
|
|
f'<span class="stars" title="{stars:,} stars">'
|
|
f'<svg width="12" height="12" viewBox="0 0 24 24" fill="currentColor"><path d="M12 2l3.09 6.26L22 9.27l-5 4.87L18.18 22 12 18.56 5.82 22 7 14.14 2 9.27l6.91-1.01L12 2z"/></svg>'
|
|
f" {format_stars(stars)}</span>"
|
|
if stars > 0
|
|
else ""
|
|
)
|
|
|
|
# Last update display
|
|
last_update_html = (
|
|
f'<span class="last-update" title="Last commit: {esc(last_commit)}">{esc(last_commit)}</span>'
|
|
if last_commit and last_commit != "error"
|
|
else ""
|
|
)
|
|
|
|
# Source flags for data attributes
|
|
sources = []
|
|
if is_github:
|
|
sources.append("github")
|
|
if is_cran:
|
|
sources.append("cran")
|
|
if is_pypi:
|
|
sources.append("pypi")
|
|
if is_commercial:
|
|
sources.append("commercial")
|
|
sources_attr = esc(" ".join(sources))
|
|
|
|
tags_html = build_tags_html(e)
|
|
|
|
rows.append(
|
|
f""" <tr class="row" data-language="{language}" data-category="{category}" data-sources="{sources_attr}" data-stars="{stars}">
|
|
<td class="col-num">{i}</td>
|
|
<td class="col-name">
|
|
<a href="{url}" target="_blank" rel="noopener">{name}</a>
|
|
<span class="mobile-category">{category}</span>
|
|
</td>
|
|
<td class="col-stars">{stars_html}</td>
|
|
<td class="col-update">{last_update_html}</td>
|
|
<td class="col-tags">
|
|
{tags_html}
|
|
</td>
|
|
<td class="col-arrow"><span class="arrow">›</span></td>
|
|
</tr>
|
|
<tr class="expand-row" hidden>
|
|
<td colspan="6">
|
|
<div class="expand-content">
|
|
<p class="expand-desc">{desc}</p>
|
|
<div class="expand-links">
|
|
<a href="{url}" target="_blank" rel="noopener">{url}</a>
|
|
{f'<a href="{github_url}" target="_blank" rel="noopener">{github_url}</a>' if github_url and github_url != url else ''}
|
|
</div>
|
|
</div>
|
|
</td>
|
|
</tr>"""
|
|
)
|
|
|
|
total = len(entries)
|
|
total_stars = sum(int(e.get("stars", 0) or 0) for e in entries)
|
|
|
|
return f"""<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Awesome Quant</title>
|
|
<meta name="description" content="A curated list of insanely awesome libraries, packages and resources for Quants (Quantitative Finance).">
|
|
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="static/style.css">
|
|
</head>
|
|
<body>
|
|
<a href="#content" class="sr-only">Skip to content</a>
|
|
|
|
<header class="hero">
|
|
<div class="hero-inner">
|
|
<nav class="nav">
|
|
<span class="nav-brand">awesome-quant</span>
|
|
<div class="nav-links">
|
|
<a href="https://github.com/wilsonfreitas/awesome-quant/blob/master/CONTRIBUTING.md" class="nav-submit">Submit a Project</a>
|
|
<a href="https://github.com/wilsonfreitas/awesome-quant">GitHub</a>
|
|
<button class="theme-toggle" aria-label="Toggle dark mode" title="Toggle dark mode">
|
|
<svg class="icon-sun" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><circle cx="12" cy="12" r="5"/><path d="M12 1v2M12 21v2M4.22 4.22l1.42 1.42M18.36 18.36l1.42 1.42M1 12h2M21 12h2M4.22 19.78l1.42-1.42M18.36 5.64l1.42-1.42"/></svg>
|
|
<svg class="icon-moon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"/></svg>
|
|
</button>
|
|
</div>
|
|
</nav>
|
|
<div class="hero-content">
|
|
<h1>Awesome Quant</h1>
|
|
<p class="hero-subtitle">A curated list of insanely awesome libraries, packages and resources for Quants.</p>
|
|
<p class="hero-maintained">Maintained by <a href="https://github.com/wilsonfreitas">Wilson Freitas</a></p>
|
|
<div class="hero-stats">
|
|
<span class="stat"><strong>{total}</strong> projects</span>
|
|
<span class="stat-sep"></span>
|
|
<span class="stat"><strong>{len(languages)}</strong> languages</span>
|
|
<span class="stat-sep"></span>
|
|
<span class="stat"><strong>{format_stars(total_stars)}</strong> total stars</span>
|
|
</div>
|
|
<a href="#content" class="hero-cta">Browse the List</a>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
|
|
<main id="content">
|
|
<section class="list-section">
|
|
<div class="shell">
|
|
<div class="controls">
|
|
<div class="search-wrap">
|
|
<svg class="search-icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><circle cx="11" cy="11" r="8"/><path d="M21 21l-4.35-4.35"/></svg>
|
|
<input type="search" id="search" class="search-input" placeholder="Search projects..." autocomplete="off" aria-label="Search projects">
|
|
<kbd class="search-kbd">/</kbd>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="filter-bar" id="filter-bar" style="display:none">
|
|
<span class="filter-label">Filtered by:</span>
|
|
<span class="filter-value" id="filter-value"></span>
|
|
<button class="filter-clear" id="filter-clear">Clear filter</button>
|
|
</div>
|
|
|
|
<div class="table-wrap">
|
|
<table class="table" id="project-table">
|
|
<thead>
|
|
<tr>
|
|
<th class="col-num">#</th>
|
|
<th class="col-name" data-sort="name">Project <span class="sort-arrow"></span></th>
|
|
<th class="col-stars" data-sort="stars">Stars <span class="sort-arrow"></span></th>
|
|
<th class="col-update" data-sort="update">Last Update <span class="sort-arrow"></span></th>
|
|
<th class="col-tags">Tags</th>
|
|
<th class="col-arrow"></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
{chr(10).join(rows)}
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="no-results" id="no-results" hidden>
|
|
<p>No projects match your search.</p>
|
|
</div>
|
|
|
|
<div class="results-count" id="results-count"></div>
|
|
</div>
|
|
</section>
|
|
|
|
<section class="cta-section">
|
|
<div class="shell">
|
|
<h2>Know a great project?</h2>
|
|
<p>Contribute to the list by opening a pull request on GitHub.</p>
|
|
<a href="https://github.com/wilsonfreitas/awesome-quant" class="btn" target="_blank" rel="noopener">Contribute on GitHub</a>
|
|
</div>
|
|
</section>
|
|
</main>
|
|
|
|
<footer class="footer">
|
|
<div class="shell">
|
|
<span>Maintained by <a href="https://github.com/wilsonfreitas">Wilson Freitas</a></span>
|
|
<span class="footer-sep">·</span>
|
|
<a href="https://github.com/wilsonfreitas/awesome-quant">GitHub</a>
|
|
<span class="footer-sep">·</span>
|
|
<a href="https://awesome.re">awesome.re</a>
|
|
</div>
|
|
</footer>
|
|
|
|
<script src="static/main.js"></script>
|
|
</body>
|
|
</html>"""
|
|
|
|
|
|
def main():
|
|
root = Path(__file__).resolve().parent.parent
|
|
readme = root / "README.md"
|
|
csv_path = root / "site" / "projects.csv"
|
|
output = root / "site" / "index.html"
|
|
|
|
# Prefer CSV if it exists (has stars, last commit from API)
|
|
if csv_path.exists():
|
|
print(f"Loading from {csv_path}")
|
|
entries = load_csv(str(csv_path))
|
|
elif readme.exists():
|
|
print(f"Parsing {readme} (no CSV — stars/dates will be empty)")
|
|
entries = parse_readme(str(readme))
|
|
else:
|
|
print(f"ERROR: neither {csv_path} nor {readme} found", file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
print(f"Loaded {len(entries)} projects")
|
|
html_content = generate_html(entries)
|
|
output.write_text(html_content, encoding="utf-8")
|
|
print(f"Generated {output}")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|