faserf/ha-whatsapp
Grade a repo

88

/ 100

GradeB

Well engineered. The main gaps are a contributing guide and a reproducible setup.

Top 14% of 5,156 graded repos

Homeassistant Integration to interact with WhatsApp

Documentation82
Engineering90
Health98
Python46MIT12d ago

Top fixes

Highest-impact changes first, ranked by point weight

6 to address
  1. 1
    Install and run instructions9pt

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

  2. 2
    Reproducibility6pt

    Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

  3. 3
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

  4. 4
    Dependency manifest6pt

    Add a [project.urls] table (Homepage, Repository) so PyPI links back to your project.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

82

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

90

Reproducibility6pt20

No dependency lockfile found (−70 pts).

→ Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

Tests18pt100

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/ci-orchestrator.yml).

Linting and formatting5pt100

Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

98

Dependency manifest6pt93

Dependency manifest found (pyproject.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 10 / 275
    Commits (30d / 90d)
  • 6
    Forks
  • 55
    Releaseslatest 8mo ago

Community

  • 42% - Weak
    Community health
  • -
    authors own >50% of commits
  • 46
    Watchers

Responsiveness

  • 13h
    Median issue response
  • 3h
    Median PR merge time
  • 9
    Open issues
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/ci-orchestrator.yml).
    Good: Issue or PR templates present.
  • custom_components
  • docs
  • scripts
  • tests
    Good: Test files detected (tests).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • EXAMPLES.md
  • hacs.json
  • 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.
  • renovate.json
    Good: Renovate is configured (renovate.json). Dependencies update automatically across every package manager it detects.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/faserf/ha-whatsapp)](https://www.repo-grade.com/report/faserf/ha-whatsapp)

More graded Python repos