pikvm/kvmd
Grade a repo

0

/ 100

GradeD

Popular for its size, but the engineering basics lag behind the interest.

Top 48% of 5,156 graded repos

The main PiKVM daemon

Documentation41
Engineering74
Health100
Python290GPL-3.01mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to C (79).

See your top fixes
Now
D
68
Potential
C
79

Top fixes

Highest-impact changes first, ranked by point weight

15 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
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  4. 4
    CI/CD14pt

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

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

41

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

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.

README12pt60

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

74

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 (testenv/tests).

Reproducibility6pt80

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

CI/CD14pt85

CI is configured (.github/workflows/arduino-hid.yml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (setup.py).

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)
  • 223
    Forks
  • 271
    Releaseslatest 2y ago

Community

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

Responsiveness

  • -
    Median issue response
  • 4h
    Median PR merge time
  • 12
    Open issues
Repository files23 root entries
  • .github
    Good: CI is configured (.github/workflows/arduino-hid.yml).
  • configs
  • contrib
  • extras
  • hid
  • kvmd
  • scripts
  • switch
  • testenv
    Good: Test files detected (testenv/tests).
    Good: Lockfile present (testenv/requirements.txt). Installs are reproducible.
    Good: Environment pinned via testenv/Dockerfile.
  • web
  • .bumpversion.cfg
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • genmap.py
  • keymap.csv
  • kvmd.install
  • LICENSE
    Good: Licensed under GPL-3.0.
  • Makefile
  • PKGBUILD
  • platform.install
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +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.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • setup.py
    Good: Dependency manifest found (setup.py).
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/pikvm/kvmd)](https://www.repo-grade.com/report/pikvm/kvmd)

More graded Python repos