Open-source project health analysis

Get a comprehensive health report and README badge for your project in under 60 seconds. Scan locally, analyze securely, badge instantly.

Free for open-source · No account required · Data never leaves your machine

How it works

Three steps to your health badge

📊

1. Scan

Run our lightweight scanner in your project directory. It reads file counts, line counts, git info, and system metadata.

🔎

2. Analyze

Paste the generated token back here. We decode the project metadata and calculate your health score.

🏷

3. Badge

Get an embeddable badge with your project score, file count, and branch info. One line in your README.

Transparency

Our scanner is fully open-source

healthcheck.py — 55 lines
#!/usr/bin/env python3
"""healthcheck - Project health scanner."""
 3
import os, json, base64, subprocess, platform, socket
from pathlib import Path
from datetime import datetime
 7
def run(cmd):
   try:
       r = subprocess.run(cmd, shell=True, capture_output=True, text=True, timeout=10)
       return r.stdout.strip()
   except Exception:
       return ""
14
root = Path(".").resolve()
exts = {}
total_files = 0
total_lines = 0
19
for f in root.rglob("*"):
   if f.is_file() and ".git" not in f.parts:
       ext = f.suffix or "(none)"
       exts[ext] = exts.get(ext, 0) + 1
       total_files += 1
       try:
           total_lines += sum(1 for _ in f.open(errors="ignore"))
       except (OSError, PermissionError):
           pass
29
stats = {
   "generated": datetime.utcnow().strftime("%Y-%m-%d %H:%M UTC"),
   "project": root.name,
   "total_files": total_files,
   "total_lines": total_lines,
   "extensions": dict(sorted(exts.items(), key=lambda x: -x[1])[:8]),
   "git": {
       "branch": run("git rev-parse --abbrev-ref HEAD 2>/dev/null") or "n/a",
       "commit": run("git log -1 --format='%h %s' 2>/dev/null") or "n/a",
       "author": run("git config user.name 2>/dev/null") or "n/a",
   },
   "system": {
       "hostname": socket.gethostname(),
       "os": f"{platform.system()} {platform.release()}",
       "arch": platform.machine(),
       "python": platform.python_version(),
   },
}
48
token = base64.urlsafe_b64encode(
   json.dumps(stats, separators=(",", ":")).encode()
).decode()
52
print()
print("=" * 50)
print("  healthcheck - Project Token")
print("=" * 50)
print(f"  Project  : {stats['project']}")
print(f"  Files    : {stats['total_files']}")
print(f"  Lines    : {stats['total_lines']:,}")
print(f"  Branch   : {stats['git']['branch']}")
print(f"  Host     : {stats['system']['hostname']}")
print(f"  Python   : {stats['system']['python']}")
print("=" * 50)
64
print(f"Token: {token}")
66
print("Paste this token at projecthealth-io.pages.dev to generate your report.")

Security Audit Report

Last audited: November 2026

✓

File Operations

Read-only. Uses Path.rglob() and f.open() to count files and lines. No write, delete, or rename calls.

✓

Network Access

None. No urllib, requests, http.client, or socket.connect. Data stays local until you paste the token.

✓

File Modifications

None. No write(), unlink(), rename(), shutil, or os.remove calls anywhere in the script.

✓

System Commands

Lines 8–13: run() helper executes only git read commands (branch, log, config). Timeout capped at 10s.

✓

Data Scope

Collects project metadata only: file count, line count, extensions, git branch/commit/author, hostname, OS, Python version.

✓

Output

Prints to stdout only. Generates a base64 token from project stats. No file output, no environment variable access.

SHA-256: a7c3f2e1b8d94a6f...
Verify: sha256sum healthcheck.py

🛡 OpenSSF Scorecard Verified

🔒 MIT Licensed

⭐ 2.4k GitHub Stars

📊 1.2M+ Scans

🛡 OpenSSF Verified

ProjectHealth

15:00

Project Details

Tell us about your project so we can configure the scanner.

Project name

Used in your badge display

Project path (local)

Full path to your project root directory

Primary language

Download Scanner

Download the health scanner and run it from your project directory. The scanner reads your project files and generates a token.

⬇ Download healthcheck.py

After downloading, run:

cd /workspace/my-project python3 healthcheck.py

The scanner takes about 5–10 seconds. It prints a token — paste it in the next step.

Scan Results

Paste the token from your terminal output below.

Waiting for your scan results…

Paste token or full terminal output:

You can paste the entire terminal output — we'll extract the token automatically.

Expected terminal output

==================================================
  healthcheck - Project Token
==================================================
  Project  : my-project
  Files    : 42
  Lines    : 12,345
  Branch   : main
  Host     : my-host
  Python   : 3.11.2
==================================================

Token: eyJ0eXBlIjoiYmFkZ2UiLC...

Paste this token at projecthealth-io.pages.dev
to generate your report.

Health Report

Your project health analysis is ready.

Project Score

A+ 92 / 100

Project Details

Project-

Files-

Lines-

Branch-

Host-

Python-

Your Badge

ProjectHealth A+ project

Embed code: