Skip to main content

Scan any GitHub repo and get an instant engineering health report card.

Project description

repocheck

PyPI

Scan any public GitHub repo and get an instant engineering health report card — README quality, CI/CD, test presence, dependency hygiene, license, commit activity, and issue hygiene, scored A–F.

$ repocheck pallets/flask

╭─ repo ──────────────────╮
│ pallets/flask           │
│ ★ 68234  ⑂ 16200  Python│
╰──────────────────────────╯
╭─ overall health score ──╮
│ 91/100  (A)              │
╰───────────────────────────╯

Check               Score  Grade
README Quality        100    A
CI/CD                  90    A
Test Presence          85    B
Dependency Hygiene     80    B
License               100    A
Commit Activity        95    A
Issue Hygiene          85    B

Install

pip install repocheck-cli

Usage

# owner/repo shorthand
repocheck pallets/flask

# full URL also works
repocheck https://github.com/psf/requests

# detailed reasoning behind every score
repocheck torvalds/linux -v

# machine-readable output (for CI pipelines, scripts)
repocheck your-org/your-repo --json

Higher rate limits

GitHub's anonymous API limit is 60 requests/hour. repocheck makes ~8 requests per scan, so you'll hit that fast without auth. Set a token to bump it to 5,000/hour:

export GITHUB_TOKEN=ghp_your_token_here
repocheck your-org/your-repo

No special scopes needed — a basic personal access token works fine for public repos.

What it checks

Check What it looks at
README Quality Presence, length, install/usage sections, badges, code blocks
CI/CD GitHub Actions workflows, legacy CI configs
Test Presence Test directories, test config files, declared test scripts
Dependency Hygiene Manifest presence, version pinning, lockfiles
License OSS license presence and type
Commit Activity Recency and message quality of recent commits
Issue Hygiene Open issue count and staleness

Each check is scored 0–100 and the overall score is an average across all seven.

Why

Most "is this repo any good" judgments are vibes-based — a glance at stars, maybe the README. repocheck turns that into a repeatable, objective-ish checklist you can run on your own repos before sharing them, or use to quickly evaluate a dependency before adopting it.

Local development

git clone https://github.com/Ahmed0754/repocheck
cd repocheck
pip install -e ".[dev]"
repocheck pallets/flask

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

repocheck_cli-0.2.0.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

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

repocheck_cli-0.2.0-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file repocheck_cli-0.2.0.tar.gz.

File metadata

  • Download URL: repocheck_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for repocheck_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 7d5c64e497d3c3a82459e36348f94c6b3f48b9cf5c1e0b6257a1197026c900c7
MD5 2fb234622d2b6e1beb32f8c64da679ee
BLAKE2b-256 a0ba3938e36459fa5876131c7938d315d439c74fd604f6d024e6635e2d5704ce

See more details on using hashes here.

File details

Details for the file repocheck_cli-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: repocheck_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for repocheck_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 248918b1039b091620abd728badc1f0af21e3cb62561e9d1951cca5124b00452
MD5 3754749d897fd19e884e9acab48ae904
BLAKE2b-256 aa69e1b4cc0fa1c9cde9ca54cc309242ea3a7ab042a10f4b24267a54c93eaf45

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