Setup vs Set Up Grammar Checker

Scans GitHub/GitLab repositories for setup used as a verb where set up is correct. Skips function/class names; checks READMEs, docs, and code comments.

• set up (verb): "Run npm install to set up the project."
• setup (noun): "The CI setup uses GitHub Actions."

Install

pip install -r requirements.txt

Usage

Single repo:

python3 setup_checker.py --repo https://github.com/user/repo

Batch (skips repos already in .setupcheck_log.json, auto-pages for new ones):

python3 setup_checker.py --max-repos 10 --github-token YOUR_TOKEN

Log management:

python3 setup_checker.py --show-log-stats
python3 setup_checker.py --clear-log

Common flags

Flag	Purpose
--repo URL	Analyze a single repo (GitHub or GitLab)
--save-report FILE	Write single-repo report to file
--max-repos N	New repos to analyze in batch mode (default 10)
--platform {github,gitlab,both}	Default both
--github-query / --gitlab-query	Search query (GitHub default: stars:>25)
--github-token / --gitlab-token	API tokens — recommended for rate limits
--output-json FILE	JSON report (batch)
--log-file PATH	Custom log location

Notes

• GitHub token: https://github.com/settings/tokens (public_repo, read:org).
• GitLab token: https://gitlab.com/-/profile/personal_access_tokens (read_api).
• Large repos are sampled (up to 50 files); search expansion capped at 10 pages.
• The website/ directory contains a static site for browsing results.