Hardware Knowledge Hub
Give your AI assistant the whole build, one time.
A hardware project comes with dozens of facts an assistant needs to make a good suggestion. Which parts are on hand? Which GPIO pins are already taken? What actually fits in the enclosure? Keep those details in one editable project notebook, then let your coding assistant read the same notes each time you work together.
Explore the live Bike Logger demo · Source on GitHub
Try it in a few minutes
pip install hardware-knowledge-hub
hardware-knowledge-hub init my-first-build
cd my-first-build
python3 hardware/knowledge/kb.py serve
Open the local editor. Your new folder starts with Bike Logger, a real Raspberry Pi project with a rear camera, sensors, and a printed enclosure.
- Explore the build. Find where parts sit in Bike, trace connections in Wiring, and inspect the enclosure in 3D Parts.
- Record what you learn. Edit Notes when a component, dimension, or design decision changes. Saving updates the project notes your assistant reads.
- Ask about the build. Open the project folder in Codex or Claude Code. The starter project points both assistants to the generated hardware notes.
Read the hardware notes. Where is the rear camera mounted, how is its cable routed, and which dimensions should I measure before changing the bracket?
You can ask the next question in a fresh chat. The project folder carries the measurements, parts list, print log, and decisions forward.
From the 3D view to your slicer
In the local editor on macOS, select a finished print in 3D Parts, choose an app, and click Open model. The app needs to be installed.
| Application | File opened |
|---|---|
| Bambu Studio | Matching 3MF when available, otherwise STL |
| OrcaSlicer | Matching 3MF when available, otherwise STL |
| PrusaSlicer | Matching 3MF when available, otherwise STL |
| FreeCAD | Matching STEP when available, otherwise STL |
You can also open the files directly from hardware/print/. The hosted demo runs in the browser. The local editor is where you save changes and launch desktop apps.
Make it yours
Use Notes for your own parts, measurements, decisions, and build log. The Bike Logger diagrams and CAD controls are examples configured for that build. Project data lives in hardware/knowledge/knowledge.json, with the generated assistant-readable notes in hardware/CLAUDE.md.
Contributing
See CONTRIBUTING.md for local development. The project is MIT-licensed.
1 maintainer
Metadata
1 maintainer
Release files for hardware-knowledge-hub 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hardware_knowledge_hub-0.2.0.tar.gz | 3.1 MB | With provenance | Details for hardware_knowledge_hub-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hardware_knowledge_hub-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for hardware_knowledge_hub-0.2.0-py3-none-any.whl |
Total release size: 6.2 MB
Release files / hardware_knowledge_hub-0.2.0.tar.gz
| Download URL | hardware_knowledge_hub-0.2.0.tar.gz |
|---|---|
| Size | 3.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
74c75830ccc64767fa7c7113bf89e8a1effb026e26d0159ce23e1ff6cf7f36dc
|
|
BLAKE2b-256 checksum How to use checksums |
a1d408f8e3f1f666b6066b8d98f32f9edb983ca536c1d9d8aa5a8407b864b788
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.
Transparency logRelease files / hardware_knowledge_hub-0.2.0-py3-none-any.whl
| Download URL | hardware_knowledge_hub-0.2.0-py3-none-any.whl |
|---|---|
| Size | 3.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
32f3b7c77249956654a0f3e9018216d41ee7d32b057e4a3f2b5f58e6daa75662
|
|
BLAKE2b-256 checksum How to use checksums |
ce039699d30c3502dd94e3951fa1bfb96fed15e3ef60c67e97813f472c19e585
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.
Transparency logSecurity for hardware-knowledge-hub 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for hardware_knowledge_hub-0.2.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
