tschamm/boschshc-hass
Grade a repo

0

/ 100

GradeC

Good shape overall. A few tweaks would push it into the top tier.

Top 45% of 5,156 graded repos

Home Assistant component for accessing Bosch Smart Home Controller using boschshcpy python library.

Documentation78
Engineering68
Health68
Python224Other1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    Tests18pt

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

  2. 2
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  3. 3
    Install and run instructions9pt

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

  4. 4
    Reproducibility6pt

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

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

78

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.

README12pt90

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

68

Reproducibility6pt0

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.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Tests18pt80

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/tests.yml).

Linting and formatting5pt100

Linter or formatter configured (.flake8).

Project health

68

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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

  • -
    Commits (30d / 90d)
  • 40
    Forks
  • 115
    Releaseslatest 5y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 224
    Watchers

Responsiveness

  • 13h
    Median issue response
  • 18h
    Median PR merge time
  • 56
    Open issues
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
  • custom_components
  • docs
  • images
  • tests
    Good: Test files detected (tests).
  • .flake8
    Good: Linter or formatter configured (.flake8).
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • hacs.json
  • info.md
  • LICENSE
    Good: Licensed under Other.
  • quality_scale.yaml
  • 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.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • requirements_test.txt
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/tschamm/boschshc-hass)](https://www.repo-grade.com/report/tschamm/boschshc-hass)

More graded Python repos