Skip to content

Commit 291e724

Browse files
committed
docs: install from the repo, since defib was never published to PyPI
README and the web UI's frame-blast fallback both tell people to run `uv tool install defib` / `pipx install defib`. There is no `defib` on PyPI — https://pypi.org/pypi/defib/json is a 404 — so both commands fail for anyone who has not already got the tool some other way. This is not theoretical. OpenIPC/firmware#2299 is a user recovering a bricked hi3518ev200: a frame-blast chip, so the web UI sent them to exactly the line above. They got defib working eventually, but when a fix landed and they were asked to reinstall, the install went to a different place than the copy on their PATH and they spent two rounds reporting results from the old build against a bug that was already fixed. Point both at the git URL, and add the uvx one-liner — it needs no install at all and cannot be shadowed by an active virtualenv, which is what went wrong in that issue. Publishing to PyPI would also close this and is worth doing; it needs a maintainer with the account, so the docs fix goes first.
1 parent 6a5c364 commit 291e724

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,18 @@ chip and firmware, connect your USB-serial adapter, and go.
1313

1414
## Installation (CLI)
1515

16+
defib is not published on PyPI — install it from the repository:
17+
1618
```bash
17-
uv tool install defib
19+
uv tool install git+https://github.com/OpenIPC/defib
1820
# or
19-
pipx install defib
21+
pipx install git+https://github.com/OpenIPC/defib
22+
```
23+
24+
To run it once without installing anything:
25+
26+
```bash
27+
uvx --from git+https://github.com/OpenIPC/defib defib burn -c <chip> -p /dev/ttyUSB0 -t
2028
```
2129

2230
## Quick Start

web/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ <h2 style="color:var(--accent)">Serial Console</h2>
618618
`frame-blast handshake (an active <code>0xAA</code>+HEAD blast plus a ` +
619619
`PRESTEP0 block) that this browser build does not implement, so the ` +
620620
`upload cannot complete here. Install defib and run:` +
621-
`<pre>uv tool install defib\ndefib burn -c ${chip} -p /dev/ttyUSB0 -t</pre>` +
621+
`<pre>uvx --from git+https://github.com/OpenIPC/defib \\\n defib burn -c ${chip} -p /dev/ttyUSB0 -t</pre>` +
622622
`Start it before you power-cycle the camera. ` +
623623
`<a href="https://github.com/OpenIPC/defib/issues/121" target="_blank" ` +
624624
`rel="noopener">Tracking issue</a>.`;

0 commit comments

Comments
 (0)