tiangolo/fastapiNew scan
95/ 100 · A

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

FastAPI framework, high performance, easy to learn, fast to code, ready for production

Python99,296 starsMITupdated today

Outstanding work. A score of 95/100 puts this repo in a very small tier of truly well-engineered open source projects.

DocumentationREADME, setup, examples, license
93
EngineeringTests, CI, linting, lockfiles
94
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Tests
    EngineeringIssue

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

  2. 2
    CI/CD
    EngineeringIssue

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD
    EngineeringInfo

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

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.
    • No .env.example found (−10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide72
    • CONTRIBUTING guide found.
    • CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    • Optional: add a Code of Conduct.A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

94
  • Tests95
    • Test files detected (docs_src/app_testing/app_a_py310/test_main.py).
    • Pytest referenced in pyproject.toml and test files present.
    • Coverage reporting is configured in pyproject.toml.
    • Test files detected (95/100) but no test runner configured (−5 pts). Without a documented test command the suite cannot be verified by contributors.Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/build-docs.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not run a lint or format check (−15 pts).Add a lint step 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 formatting100
    • Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).
  • Reproducibility100
    • Lockfile present (uv.lock). Installs are reproducible.
    • Environment pinned via .python-version.
    • Dependabot covers 3 ecosystems (github-actions, uv, pre-commit). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

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).
    • 99,296 stars.
  • Housekeeping100
    • .gitignore present.
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/build-docs.yml).
    Good: Dependabot covers 3 ecosystems (github-actions, uv, pre-commit). Dependencies stay current.
    Good: Issue or PR templates present.
  • docs
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
  • docs_src
    Good: Test files detected (docs_src/app_testing/app_a_py310/test_main.py).
  • fastapi
  • scripts
  • tests
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .python-version
    Good: Environment pinned via .python-version.
  • CITATION.cff
  • 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.
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.