Metadata-Version: 2.4
Name: hardware-knowledge-hub
Version: 0.2.0
Summary: A local project notebook for your first hardware build
License-Expression: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# 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](https://murathany7.github.io/hardware-knowledge-hub/) · [Source on GitHub](https://github.com/murathany7/hardware-knowledge-hub)

## Try it in a few minutes

```sh
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](http://127.0.0.1:8765). Your new folder starts with Bike Logger, a real Raspberry Pi project with a rear camera, sensors, and a printed enclosure.

1. **Explore the build.** Find where parts sit in **Bike**, trace connections in **Wiring**, and inspect the enclosure in **3D Parts**.
2. **Record what you learn.** Edit **Notes** when a component, dimension, or design decision changes. Saving updates the project notes your assistant reads.
3. **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](https://github.com/murathany7/hardware-knowledge-hub/blob/main/CONTRIBUTING.md) for local development. The project is MIT-licensed.
