qmk/qmk_firmware

[Bug] Documentation suggests using pyhidapi

Open

#26047 opened on Mar 3, 2026

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C (20,368 stars) (43,867 forks)batch import
bughelp wanted

Description

Describe the Bug

Some documentation page shows how to use Python to communicate with a QMK device. It suggests using pyhidapi, which is a bit confusing for those who don't know the naming mess of pyhidapi. In fact, if you follow along and run pip install pyhidapi, you'll end up with some abandoned package version 0.0.2 which for better or worse does not import as import hid.

Contributor guide

Tech stack
pythonc
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Pythonpip usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue is about the documentation page at docs/features/rawhid.md suggesting pyhidapi, which is outdated. The fix involves editing that markdown file to recommend the correct hidapi package (e.g., 'pip install hidapi') and updating the import example. Maintainer comments may clarify the preferred package. No linked PRs exist yet.