kpole95/pii-scrubber
Grade a repo

0

/ 100

GradeC

Solid engineering. The biggest lever is the README. Impressive for a brand-new repo.

Top 36% of 5,156 graded repos
Documentation63
Engineering85
Health80
Python1MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

12 to address
  1. 1
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  2. 2
    README12pt

    Link to a deployed version, docs site, or demo video. Users want to see it running.

  3. 3
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  4. 4
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

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

63

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt50

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

85

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt80

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

Tests18pt100

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/ci.yml).

Linting and formatting5pt100

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

Project health

80

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt86

Dependency manifest found (pyproject.toml).

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)
  • 0
    Forks
  • 0
    Releases

Community

  • 28% - Weak
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 1
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • configs
  • research
  • scripts
  • src
  • tests
    Good: Test files detected (tests).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .python-version
    Good: Environment pinned via .python-version.
  • LICENSE
    Good: Licensed under MIT.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Good: README has code examples.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • RESULTS.md
  • 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/kpole95/pii-scrubber)](https://www.repo-grade.com/report/kpole95/pii-scrubber)

More graded Python repos