Skip to content

Commit bbefeb5

Browse files
codeSamuraiiCopilot
andcommitted
Documentation
Co-authored-by: Copilot <copilot@github.com>
1 parent 7638112 commit bbefeb5

5 files changed

Lines changed: 84 additions & 267 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ After setup, tasks are signed automatically. No client-side code changes. See [S
8686
| **Progress & cancellation** | `pyfuse.progress(3, 10)` inside tasks; `await future.cancel()` on client |
8787
| **Heartbeat & stall detection** | Workers heartbeat; clients raise `TaskStalled` on silence |
8888
| **Content-hash caching** | Same code = cache hit, regardless of client |
89-
| **Pluggable backends** | `redis://` (multi-machine) or `local://` (same-machine TCP) |
89+
| **Pluggable backends** | `local://` (same-machine TCP), `redis://`, `amqp://` (RabbitMQ) |
9090
| **Docker sandbox** | Container isolation, transparent to clients |
9191
| **Signed execution** | Pre-shared token or PIN pairing + HMAC-SHA256 task authentication |
9292
| **Graceful shutdown** | Ctrl+C drains in-flight tasks; second Ctrl+C force-quits |

docs/CONTEXT.md

Lines changed: 0 additions & 218 deletions
This file was deleted.

docs/QUICK_START.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44

55
```bash
66
pip install pyfuse
7-
pip install pyfuse[redis] # for Redis backend (multi-machine)
7+
pip install pyfuse[redis] # Redis backend (multi-machine)
8+
pip install pyfuse[rabbitmq] # RabbitMQ backend (multi-machine, AMQP)
89
```
910

11+
pyfuse itself has zero runtime dependencies. Backend extras are only needed when you actually use the corresponding URL scheme.
12+
1013
## Remote execution
1114

1215
Add `@trace` to the entry point. Everything it calls is captured automatically.
@@ -162,14 +165,16 @@ After setup, tasks are signed automatically. No client-side code changes. See [S
162165

163166
## Backends
164167

165-
| Backend | URL | Use case |
166-
|---------|-----|----------|
167-
| Local | `local://host:port` | Same-machine IPC (async TCP, no deps) |
168-
| Redis | `redis://host:port` | Multi-machine production |
168+
| Backend | URL | Install | Use case |
169+
|---------|-----|---------|----------|
170+
| Local | `local://host:port` | (built-in) | Same-machine IPC (async TCP, no deps) |
171+
| Redis | `redis://host:port` | `pip install pyfuse[redis]` | Multi-machine production |
172+
| RabbitMQ | `amqp://host:port` | `pip install pyfuse[rabbitmq]` | Multi-machine production with AMQP |
169173

170174
```python
171175
pyfuse.connect("local://localhost:9748")
172176
pyfuse.connect("redis://localhost:6379")
177+
pyfuse.connect("amqp://guest:guest@localhost/")
173178
```
174179

175180
Or: `export PYFUSE_BACKEND=redis://localhost:6379`

0 commit comments

Comments
 (0)