psf/blackNew scan
93/ 100 · A

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

The uncompromising Python code formatter

Python41,559 starsMITupdated 5d ago
DocumentationREADME, setup, examples, license
91
EngineeringTests, CI, linting, lockfiles
91
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  2. 2
    Install and run instructions
    DocumentationInfo

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

  3. 3
    Reproducibility
    EngineeringWarning

    Commit a lockfile (package-lock.json, poetry.lock, uv.lock, etc.) so installs produce the same result everywhere.

Detailed breakdown

Documentation

91
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide58
    • CONTRIBUTING guide is very brief (0 pts for depth); 150+ words earns +6 pts, 400+ earns +12 pts.Add setup instructions, code style notes, and how to run tests.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide describes code style expectations.
    • Contributing guide lacks a testing section (−8 pts).Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    • Contributing guide lacks a PR workflow section (−8 pts).Explain how to fork, branch, and open a pull request so contributors know what to expect.
    • Contributing guide has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Code of conduct present.

Engineering

91
  • Tests100
    • Test files detected (tests).
    • Pytest configured via [tool.pytest.ini_options] in pyproject.toml with test files present.
    • Coverage reporting is configured in pyproject.toml.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/lint.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • Linter or formatter configured (.flake8).
    • pyproject.toml configures both a formatter/linter (ruff/black) and type checking (mypy).
  • Reproducibility30
    • No dependency lockfile found (−70 pts).Commit a lockfile (package-lock.json, poetry.lock, uv.lock, etc.) so installs produce the same result everywhere.
    • Environment pinned via Dockerfile.
    • Dockerfile uses multi-stage builds (smaller, more secure images).
    • Dependabot covers 2 ecosystems (github-actions, pip). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (pyproject.toml).
    • pyproject.toml has a [project] table with package metadata.
    • pyproject.toml includes a description.
    • pyproject.toml specifies requires-python, preventing installs on incompatible versions.
    • pyproject.toml has a [build-system] table. The package can be built and published.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Python.
    • pyproject.toml [project] metadata is complete (description, authors, urls).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 41,559 stars.
  • Housekeeping100
    • .gitignore present.
Repository files28 root entries
  • .github
    Info: CONTRIBUTING guide is very brief (0 pts for depth); 150+ words earns +6 pts, 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Info: 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.
    Info: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Info: 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.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
    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
  • 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