psf/black
Grade a repo

93

/ 100

GradeA

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Top 8% of 5,156 graded repos

The uncompromising Python code formatter

Documentation91
Engineering91
Health100
Python41,690MIT29d ago

Top fixes

Highest-impact changes first, ranked by point weight

7 to address
  1. 1
    Install and run instructions9pt

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

  2. 2
    Reproducibility6pt

    Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

  3. 3
    Contributing guide5pt

    Add setup instructions, code style notes, and how to run tests.

  4. 4
    Contributing guide5pt

    Show new contributors how to get a local dev environment running.

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

91

Contributing guide5pt60

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

91

Reproducibility6pt30

No dependency lockfile found (−70 pts).

→ Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

Tests18pt100

Test files detected (tests).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.flake8).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

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

  • 33 / 84
    Commits (30d / 90d)
  • 2,796
    Forks
  • 55
    Releaseslatest 5y ago

Community

  • 87% - Good
    Community health
  • 5 bus factor
    authors own >50% of commits
  • 41,690
    Watchers

Responsiveness

  • 9h
    Median issue response
  • 4h
    Median PR merge time
  • 291
    Open issues
Repository files28 root entries
  • .github
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, pip). Dependencies stay current.
    Good: Issue or PR templates present.
  • action
  • autoload
  • docs
  • plugin
  • profiling
  • scripts
  • src
  • tests
    Good: Test files detected (tests).
  • .flake8
    Good: Linter or formatter configured (.flake8).
  • .git_archival.txt
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .pre-commit-hooks.yaml
  • .prettierrc.yaml
  • .readthedocs.yaml
  • action.yml
  • AUTHORS.md
  • CHANGES.md
  • CITATION.cff
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • 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.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.
  • tox.ini
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/psf/black)](https://www.repo-grade.com/report/psf/black)

More graded Python repos