This release is a pre-release and may not be stable for production use.
starfish-outbox
A durable, per-identity offline write-queue — the client-side complement to the
server-side queuing extension.
Generic over the queued item: you own what an item is, supply its dedup id, and a
send that performs the real write. The queue handles persistence (write-through to a
LocalCache), dedup-by-id, single-shot claim (no double-send), attempt counting with
auto-retry-then-fail, crash-safe recovery of stuck sending entries, and subscriptions.
drain_outbox is connectivity-agnostic — you trigger it on whatever reconnect signal you have.
Install
pip install starfish-outbox
Usage
from starfish_outbox import OutboxQueue, drain_outbox
queue: OutboxQueue = OutboxQueue(local_cache) # local_cache: async get_item / set_item / remove_item
await queue.hydrate(f"outbox.{user_id}")
# Enqueue a write while offline (the id is yours to thread into the eventual write):
await queue.enqueue(write_id, {"path": path, "body": body})
# Drain on reconnect:
async def send(entry):
await client.push(entry.item["path"], entry.item["body"], base_hash_for(entry.item["path"]))
await drain_outbox(queue, send, max_attempts=5)
Mutating methods (enqueue / claim / remove / retry / …) are async because each
writes through to the cache; get / pending / subscribe are synchronous. JSON-compatible
on disk with the TypeScript @drakkar.software/starfish-outbox.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file starfish_outbox-3.0.0a71.tar.gz.
File metadata
- Download URL: starfish_outbox-3.0.0a71.tar.gz
- Upload date:
- Size: 5.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44070866792ebe6395b0e6fbdef57f2e3079277fd417321625da2502ae84ed14
|
|
| MD5 |
5ce13e2b58c1a2968263b14ad25c444c
|
|
| BLAKE2b-256 |
bacbc63fb605268a6c1a5f7f60c59052101dbf23a52c324b6eb3549811c6096e
|
File details
Details for the file starfish_outbox-3.0.0a71-py3-none-any.whl.
File metadata
- Download URL: starfish_outbox-3.0.0a71-py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9212170b769177e0a7fef0b0c6dfbed465d158a3bcdb2feef3e5d12b0ddfab76
|
|
| MD5 |
2fe5cb417059636e0d5f132b1f1e8600
|
|
| BLAKE2b-256 |
30cb9d1bd5fd459c733adbc3d321bd57c0f2df8e62dd4182b459ac17de2479f8
|
