python/mypyNew scan
88/ 100 · B

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

Optional static typing for Python

Python20,476 starsOtherupdated 4d ago
DocumentationREADME, setup, examples, license
90
EngineeringTests, CI, linting, lockfiles
83
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

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

  3. 3
    README
    DocumentationInfo

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

Detailed breakdown

Documentation

90
  • README85
    • README is present.
    • README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    • 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 guide90
    • 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.
    • 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

83
  • Tests100
    • Test files detected (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/build_wheels.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.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • Linter or formatter configured (.editorconfig).
    • pyproject.toml configures a Python formatter or linter (ruff/black).
    • No [tool.mypy] in pyproject.toml (−20 pts vs having both ruff and mypy).Install mypy and add a [tool.mypy] section to pyproject.toml for type checking.
  • Reproducibility10
    • 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 misc/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 templates90
    • 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

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).
    • 20,476 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (mypy/typeshed/stdlib/venv/__init__.pyi) (−40 pts).Remove them and add to .gitignore.
Repository files30 root entries
  • .github
    Good: CI is configured (.github/workflows/build_wheels.yml).
    Good: Issue or PR templates present.
  • docs
  • misc
    Good: Environment pinned via misc/docker/Dockerfile.
  • mypy
    Warning: Build artifacts or local files may be committed (mypy/typeshed/stdlib/venv/__init__.pyi) (−40 pts).Fix: Remove them and add to .gitignore.
  • mypyc
  • test-data
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • action.yml
  • build-requirements.txt
  • 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.
  • conftest.py
    Good: Test files detected (conftest.py).
  • CONTRIBUTING.md
  • CREDITS
  • LICENSE
    Good: Licensed under Other.
  • MANIFEST.in
  • mypy_bootstrap.ini
  • mypy_self_check.ini
  • mypy-requirements.txt
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Info: README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
  • runtests.py
  • setup.py
  • test-requirements.in
  • test-requirements.txt
  • tox.ini