Skip to main content

A unified health scoring tool for GitHub repositories. Track dependency freshness, CI health, PR/issue age, and more — all in one score.

Project description

Repo Health Score

A unified health scoring tool for GitHub repositories. Track dependency freshness, CI health, PR/issue age, and more — all in one letter grade.

Installation

pip install repo-health-score

Or install from source:

git clone https://github.com/CatfishGG/repo-health-score.git
cd repo-health-score
pip install -e .

Quick Start

# Set your GitHub token
export GITHUB_TOKEN=ghp_your_token_here

# Scan a single repo
repo-health-score owner/repo

# Scan all your repos
repo-health-score --all-repos

# Scan a specific user/org
repo-health-score --user some-org

# Output as JSON
repo-health-score owner/repo --output json

Score Dimensions

Dimension Weight What it measures
Dependencies 25% Security vulnerabilities, outdated packages
CI/CD 20% Build success rate, workflow health
Pull Requests 20% PR age, stale PRs, review turnaround
Issues 15% Issue age, stale issues, response rate
Community 10% License, contributing guidelines, templates
Documentation 10% README quality, doc freshness

Configuration

Custom Weights

repo-health-score owner/repo --weights '{"dependencies":0.4,"ci_cd":0.1}'

Output Formats

repo-health-score owner/repo --output summary  # Default: human-readable
repo-health-score owner/repo --output table     # Table view
repo-health-score owner/repo --output json      # Full JSON

Write to file

repo-health-score --all-repos --json-output health-report.json

Authentication

Personal Access Token (PAT)

export GITHUB_TOKEN=ghp_your_token
repo-health-score owner/repo

PAT requires repo scope for full access.

GitHub App (coming soon)

GitHub App authentication for organisations with tighter permissions.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repo_health_score-0.1.0.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

repo_health_score-0.1.0-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file repo_health_score-0.1.0.tar.gz.

File metadata

  • Download URL: repo_health_score-0.1.0.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for repo_health_score-0.1.0.tar.gz
Algorithm Hash digest
SHA256 565f932e04425e66c33d5f437dac9eb1831c619c14ed9caf3cbc5287f229341f
MD5 73dcedd113c10f2f42a630621e13250c
BLAKE2b-256 6071c50ce3ca02d529eeb38f93dfea77d2f0777bd74500a6709988fad3c4ee2e

See more details on using hashes here.

File details

Details for the file repo_health_score-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for repo_health_score-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21787f9d0cb2057993902829e078b8efe627d84d53fe7b0a9624bdfd2f43ec76
MD5 fad8fd442eadddcfe0f95468ce7aec21
BLAKE2b-256 9a0c3f85fc49e5821c55b8afdeb9b7d1216c8653dad05c5da9ad3361710d78f8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page