policyengine/policyengine-us
Grade a repo

0

/ 100

GradeB

Polished and well engineered. Punching above its star count.

Top 22% of 5,156 graded repos

The PolicyEngine US Python package contains a rules engine of the US tax-benefit system, and microdata generation for microsimulation analysis.

Documentation68
Engineering90
Health98
Python147AGPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

10 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    README12pt

    Expand with a description, install steps, usage, and examples.

  3. 3
    README12pt

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

  4. 4
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

68

Install and run instructions9pt45

README documents how to install the project.

README12pt60

README is present.

Contributing guide5pt92

Contributing guide is detailed and thorough.

License6pt100

Licensed under AGPL-3.0.

Engineering

90

Tests18pt80

Test files detected (policyengine_us/conftest.py).

Reproducibility6pt80

Lockfile present (uv.lock). Installs are reproducible.

CI/CD14pt100

CI is configured (.github/workflows/rebuild-model-site.yml).

Linting and formatting5pt100

Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

98

Dependency manifest6pt93

Dependency manifest found (pyproject.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 210
    Forks
  • 6
    Releaseslatest 2y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 147
    Watchers

Responsiveness

  • 112d 3h
    Median issue response
  • 20h
    Median PR merge time
  • 1,100
    Open issues
Repository files24 root entries
  • .claude
  • .github
    Good: CI is configured (.github/workflows/rebuild-model-site.yml).
    Good: Issue or PR templates present.
  • .vscode
  • changelog.d
  • docs
  • docs-quarto
  • policyengine_us
    Good: Test files detected (policyengine_us/conftest.py).
  • .coveragerc
  • .gitignore
    Good: .gitignore present.
  • .python-version
    Good: Environment pinned via .python-version.
  • AGENTS.md
  • CHANGELOG.md
  • CLAUDE.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • environment.yml
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • Makefile
  • MANIFEST.in
  • PSL_catalog.json
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • test.py
  • update_itemization.sh
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/policyengine/policyengine-us)](https://www.repo-grade.com/report/policyengine/policyengine-us)

More graded Python repos