ramses-rf/ramses_rf
Grade a repo

0

/ 100

GradeA

Well engineered for its size. A portfolio piece worth showing off.

An interface for the RAMSES-II RF protocol, as used by Honeywell-compatible HVAC & CH/DHW systems.

Documentation89
Engineering99
Health93
Python82MITtoday

Outstanding. A score of 95/100 puts this repo in a very small tier of truly well-engineered projects.

Documentation

89

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt93

README is present.

License6pt100

Licensed under MIT.

Engineering

99

Reproducibility6pt90

Lockfile present (requirements/requirements.txt). Installs are reproducible.

Tests18pt100

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/check-cov.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

93

Dependency manifest6pt77

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

  • -
    Commits (30d / 90d)
  • 28
    Forks
  • 51
    Releaseslatest 8mo ago

Community

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

Responsiveness

  • 5h
    Median issue response
  • <1h
    Median PR merge time
  • 22
    Open issues
Repository files16 root entries
  • .github
    Good: CI is configured (.github/workflows/check-cov.yml).
    Good: Dependabot covers 2 ecosystems (pip, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • docs
  • misc
  • requirements
    Good: Lockfile present (requirements/requirements.txt). Installs are reproducible.
  • src
  • tests
    Good: Test files detected (tests).
  • typings
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • client.py
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • LICENSE
    Good: Licensed under MIT.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README-developers.md
    Good: README is present.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
  • README.md