ericvh's picture
Publishing docs and metadata fixes
73a21c2 verified
|
Raw History Blame Contribute Delete
2.82 kB
---
title: Device Connect Driver
emoji: 📡
colorFrom: gray
colorTo: indigo
sdk: static
pinned: false
short_description: Device Connect driver and portal settings for Reachy Mini
tags:
- reachy_mini
- reachy_mini_python_app
---
## Device Connect Edge Driver
Thin [Hugging Face Space](https://huggingface.co/docs/hub/spaces) package wrapping the
**reachy-mini-driver** package (Driver repository: link your own GitHub `reachy-mini-driver` fork in this README when you publish).
### Generate `pyproject.toml` (required)
`pyproject.toml` is **generated** by `sync_driver_dependency.py` so `reachy-mini-driver` is referenced with a URL pip can resolve (bare `file:..` breaks in the assistant’s temp venv).
**Local monorepo / `reachy-mini-app-assistant check`:**
```bash
python device-connect-driver/sync_driver_dependency.py local
reachy-mini-app-assistant check device-connect-driver
```
**Reset committed placeholder** (invalid until you set GitHub username):
```bash
python device-connect-driver/sync_driver_dependency.py template
```
**Before `reachy-mini-app-assistant publish`** (HF uploads only this folder—use Git or PyPI):
```bash
python device-connect-driver/sync_driver_dependency.py git --url 'git+https://github.com/<you>/reachy-mini-driver.git@main'
# or: python device-connect-driver/sync_driver_dependency.py pypi --version 0.1.0
reachy-mini-app-assistant publish device-connect-driver
```
### Community marketplace
The folder name **`device-connect-driver`** is the Hugging Face Space slug (e.g. `ericvh/device-connect-driver` in the app marketplace—not `hf_space`).
Uses the standard Reachy flow: [Make and publish your Reachy Mini App](https://huggingface.co/blog/pollen-robotics/make-and-publish-your-reachy-mini-apps).
### Publishing troubleshooting
| Symptom | Fix |
|--------|-----|
| `colorFrom` / `short_description` rejected on push | Use `colorFrom: gray` (not `slate`). Keep `short_description` ≤ 60 characters. |
| `pip install` fails during `check` | Use Python 3.11–3.12, stable network, and `pip install huggingface-hub==1.3.0` if `reachy-mini` conflicts. Re-run `sync_driver_dependency.py git` after pushing driver changes to GitHub. |
| `git push` / no upstream branch | Normal in this monorepo: the assistant falls back to the Hugging Face API upload. Do **not** keep a nested `device-connect-driver/.git` (delete it if present). |
| Still publishing `hf_space` | Use `reachy-mini-app-assistant publish device-connect-driver`, not `hf_space`. |
One-shot publish from the repo root:
```bash
python device-connect-driver/sync_driver_dependency.py git --url 'git+https://github.com/ericvh/reachy-mini-driver.git@main'
reachy-mini-app-assistant check device-connect-driver
reachy-mini-app-assistant publish device-connect-driver "Update app" --public
```