prefecthq/prefectNew scan
92/ 100 · A

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

Prefect is a workflow orchestration framework for building resilient data pipelines in Python.

Python22,607 starsApache-2.0updated 2d ago
DocumentationREADME, setup, examples, license
86
EngineeringTests, CI, linting, lockfiles
96
Project healthDescription, activity, stars, deps
94

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
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

Detailed breakdown

Documentation

86
  • README80
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • 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 Apache-2.0.
  • Contributing guide75
    • CONTRIBUTING guide or docs directory present.
    • Code of conduct present.

Engineering

96
  • Tests100
    • Test files detected (docs/conftest.py).
    • Pytest is fully configured in pyproject.toml with testpaths and test files detected.
    • Coverage reporting is configured in pyproject.toml.
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/api-compatibility-tests.yaml).
    • 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.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • Linter or formatter configured (ui-v2/biome.json).
    • pyproject.toml configures both a formatter/linter (ruff/black) and type checking (mypy).
  • Reproducibility100
    • Lockfile present (uv.lock). Installs are reproducible.
    • Environment pinned via Dockerfile.
    • Dockerfile uses multi-stage builds (smaller, more secure images).
    • Dependabot covers 5 ecosystems (pip, npm, github-actions, docker, uv). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

94
  • 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).
    • 22,607 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (ui-v2/.env) (−40 pts).Remove them and add to .gitignore.
Repository files34 root entries
  • .claude
  • .github
    Good: CONTRIBUTING guide or docs directory present.
    Good: CI is configured (.github/workflows/api-compatibility-tests.yaml).
    Good: Dependabot covers 5 ecosystems (pip, npm, github-actions, docker, uv). Dependencies stay current.
    Good: Issue or PR templates present.
  • benches
  • client
  • docs
    Good: Test files detected (docs/conftest.py).
  • examples
  • integration-tests
  • load_testing
  • plans
  • schemas
  • scripts
  • src
  • tests
  • tools
  • ui
  • ui-v2
    Good: Linter or formatter configured (ui-v2/biome.json).
    Warning: Build artifacts or local files may be committed (ui-v2/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .nvmrc
  • .pre-commit-config.yaml
  • .prefectignore
  • AGENTS.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • compat-tests
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.sqlite-builder
  • hatch_build.py
  • justfile
  • LICENSE
    Good: Licensed under Apache-2.0.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: 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.
    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.
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.