|
| 1 | +"""Pull floe-guard's public adoption metrics into a single snapshot. |
| 2 | +
|
| 3 | +No dependencies — stdlib only. Reads public APIs: |
| 4 | + - GitHub repo stats (stars, forks, watchers) — no auth needed |
| 5 | + - GitHub traffic (views, clones) — needs a token with push access |
| 6 | + - PyPI downloads (last day / week / month) — no auth needed (pypistats.org) |
| 7 | +
|
| 8 | +Usage: |
| 9 | + python scripts/metrics.py |
| 10 | + GITHUB_TOKEN=ghp_xxx python scripts/metrics.py # also fetch traffic (views/clones) |
| 11 | +
|
| 12 | +These are the runbook KPIs (star velocity, forks, install velocity). Run it on a |
| 13 | +schedule and diff snapshots to get velocity. It only reports real numbers — if a |
| 14 | +source is unreachable it says so rather than guessing. |
| 15 | +""" |
| 16 | +from __future__ import annotations |
| 17 | + |
| 18 | +import json |
| 19 | +import os |
| 20 | +import urllib.error |
| 21 | +import urllib.request |
| 22 | + |
| 23 | +REPO = "Floe-Labs/floe-guard" |
| 24 | +PACKAGE = "floe-guard" |
| 25 | + |
| 26 | + |
| 27 | +def _get(url: str, headers: dict[str, str] | None = None, timeout: float = 15.0): |
| 28 | + req = urllib.request.Request(url, headers=headers or {}) |
| 29 | + with urllib.request.urlopen(req, timeout=timeout) as resp: # noqa: S310 (trusted hosts) |
| 30 | + return json.loads(resp.read().decode()) |
| 31 | + |
| 32 | + |
| 33 | +def github_repo() -> dict[str, object]: |
| 34 | + try: |
| 35 | + d = _get( |
| 36 | + f"https://api.github.com/repos/{REPO}", |
| 37 | + headers={"Accept": "application/vnd.github+json", "User-Agent": "floe-guard-metrics"}, |
| 38 | + ) |
| 39 | + return { |
| 40 | + "stars": d.get("stargazers_count"), |
| 41 | + "forks": d.get("forks_count"), |
| 42 | + "watchers": d.get("subscribers_count"), |
| 43 | + "open_issues": d.get("open_issues_count"), |
| 44 | + } |
| 45 | + except (urllib.error.URLError, ValueError) as e: |
| 46 | + return {"error": f"github repo stats unavailable: {e}"} |
| 47 | + |
| 48 | + |
| 49 | +def github_traffic() -> dict[str, object]: |
| 50 | + token = os.environ.get("GITHUB_TOKEN", "").strip() |
| 51 | + if not token: |
| 52 | + return {"note": "set GITHUB_TOKEN (push access) to fetch views/clones"} |
| 53 | + hdr = { |
| 54 | + "Authorization": f"Bearer {token}", |
| 55 | + "Accept": "application/vnd.github+json", |
| 56 | + "User-Agent": "floe-guard-metrics", |
| 57 | + } |
| 58 | + out: dict[str, object] = {} |
| 59 | + for kind in ("views", "clones"): |
| 60 | + try: |
| 61 | + d = _get(f"https://api.github.com/repos/{REPO}/traffic/{kind}", headers=hdr) |
| 62 | + out[kind] = {"count": d.get("count"), "uniques": d.get("uniques")} |
| 63 | + except (urllib.error.URLError, ValueError) as e: |
| 64 | + out[kind] = {"error": str(e)} |
| 65 | + return out |
| 66 | + |
| 67 | + |
| 68 | +def pypi_downloads() -> dict[str, object]: |
| 69 | + try: |
| 70 | + d = _get( |
| 71 | + f"https://pypistats.org/api/packages/{PACKAGE}/recent", |
| 72 | + headers={"User-Agent": "floe-guard-metrics"}, |
| 73 | + ) |
| 74 | + return d.get("data", {"error": "no data field"}) |
| 75 | + except (urllib.error.URLError, ValueError) as e: |
| 76 | + return {"error": f"pypistats unavailable (new packages take ~1 day to appear): {e}"} |
| 77 | + |
| 78 | + |
| 79 | +def main() -> None: |
| 80 | + snapshot = { |
| 81 | + "repo": REPO, |
| 82 | + "package": PACKAGE, |
| 83 | + "github": github_repo(), |
| 84 | + "traffic": github_traffic(), |
| 85 | + "pypi_downloads_recent": pypi_downloads(), |
| 86 | + } |
| 87 | + print(json.dumps(snapshot, indent=2)) |
| 88 | + |
| 89 | + |
| 90 | +if __name__ == "__main__": |
| 91 | + main() |
0 commit comments