benoitc/gunicornNew scan
92/ 100 · A

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

gunicorn 'Green Unicorn' is a WSGI HTTP Server for UNIX, fast clients and sleepy applications.

Python10,600 starsOtherupdated 1mo ago
DocumentationREADME, setup, examples, license
93
EngineeringTests, CI, linting, lockfiles
91
Project healthDescription, activity, stars, deps
95

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    Install and run instructions
    DocumentationInfo

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

Detailed breakdown

Documentation

93
  • 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 Other.
  • Contributing guide73
    • Contributing guide is detailed and thorough.
    • 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 describes the PR/review workflow.
    • Contributing guide has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

91
  • Tests100
    • Test files detected (examples/celery_alternative/tests).
    • Pytest is fully configured in pyproject.toml with testpaths and test files detected.
  • CI/CD85

    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 does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • 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 caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
  • Linting and formatting60
    • Linter or formatter configured (.pylintrc).
  • Reproducibility92
    • Lockfile present (uv.lock). Installs are reproducible.
    • Environment pinned via docker/Dockerfile.
    • Dependabot configured for github-actions.
    • Dependabot only covers one ecosystem (+12 pts; covering 2+ earns +20 pts).Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

95
  • 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).
  • Activity80
    • Actively maintained (pushed within 3 months).
    • 10,600 stars.
  • Housekeeping100
    • .gitignore present.
Repository files27 root entries
  • .github
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • benchmarks
  • docker
    Good: Environment pinned via docker/Dockerfile.
  • docs
  • examples
    Good: Test files detected (examples/celery_alternative/tests).
  • gunicorn
  • overrides
  • scripts
  • tests
  • .gitignore
    Good: .gitignore present.
  • .pylintrc
    Good: Linter or formatter configured (.pylintrc).
  • appveyor.yml
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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).
    Good: Contributing guide describes the PR/review workflow.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • LICENSE
    Good: Licensed under Other.
  • MAINTAINERS
  • Makefile
  • MANIFEST.in
  • mkdocs.yml
  • NOTICE
  • 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.
  • requirements_dev.txt
  • requirements_test.txt
  • SECURITY.md
    Good: Security policy present.
  • THANKS
  • tox.ini
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.