qmk/qmk_firmware

[Bug] Documentation suggests using pyhidapi

Closed

#26,047 opened on Mar 3, 2026

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

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

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

Research direction
Update the documentation to replace references to 'pyhidapi' with the correct Python package 'hidapi' (or 'pyhidapi' as 'hid' import) and clarify the import statement.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85