gradio-app/gradioNew scan
95/ 100 Β· A

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

Build and share delightful machine learning apps, all in Python. 🌟 Star to support our work!

Python42,922 starsApache-2.0updated 3d ago

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
96
EngineeringTests, CI, linting, lockfiles
97
Project healthDescription, activity, stars, deps
88

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

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

  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

96
  • 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 Apache-2.0.
  • Contributing guide95
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide lacks a code style section (βˆ’8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

97
  • Tests100
    • Test files detected (.config/vitest.config.ts).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/test-functional.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.
    • 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 formatting95
    • Linter or formatter configured (.config/.prettierrc.json).
    • Lint script wired into package.json.
    • tsconfig.json has `strict: true`. Full TypeScript type safety enabled.
  • Reproducibility80
    • Lockfile present (pnpm-lock.yaml). Installs are reproducible.
    • Environment pinned via test/test_docker/Dockerfile.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

88
  • Dependency manifest75
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json has no repository field (βˆ’10 pts).Add a `repository` field pointing to the GitHub URL so npm knows where the source lives.
    • package.json has no keywords (βˆ’8 pts).Add a `keywords` array to help people find your package on npm.
    • package.json has no homepage field (βˆ’7 pts).Add a `homepage` field pointing to your docs or project website.
  • Repository metadata85
    • Repository has a description.
    • Primary language detected: Python.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 42,922 stars.
  • Housekeeping100
    • .gitignore present.
Repository files50 root entries
  • .agents
  • .changeset
  • .claude
  • .config
    Good: Test files detected (.config/vitest.config.ts).
    Good: Linter or formatter configured (.config/.prettierrc.json).
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/test-functional.yml).
    Good: Issue or PR templates present.
  • .storybook
  • .vscode
  • client
  • demo
  • ffmpeg-bin
  • gradio
  • guides
  • home
  • js
  • patches
  • readme_files
    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.
  • scripts
  • test
    Good: Environment pinned via test/test_docker/Dockerfile.
  • testing-guidelines
  • _worker.bundle
  • .dockerignore
  • .editorconfig
  • .git-blame-ignore-revs
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • build_pypi.sh
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Info: Contributing guide lacks a code style section (βˆ’8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CITATION.cff
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • cs.js
  • globals.d.ts
  • LICENSE
    Good: Licensed under Apache-2.0.
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • pyproject.toml
  • readme_template.md
  • README.md
  • render_readme.py
  • renovate.json
  • requirements-mcp.txt
  • requirements-oauth.txt
  • requirements.txt
  • SECURITY.md
    Good: Security policy present.
  • style.md
  • svelte.config.js
  • tsconfig.json
  • tsconfig.tmp.json