theflock-sdk (Python)

pip install theflock-sdk

Package is theflock-sdk on PyPI; the import name is theflock_sdk (underscore).

import asyncio
from theflock_sdk import FlockClient, derive_frequency

async def main():
    # Connects to https://api.theflock.ink by default.
    async with FlockClient() as c:
        await c.broadcast("@aaaa.bbbb.cccc", "hello flock")
        async for b in c.tune_in("@aaaa.bbbb.cccc"):
            print(b.frequency, b.carrier_text)

# Or override for local dev / self-hosted:
# async with FlockClient("http://localhost:3000") as c: ...

asyncio.run(main())

API

• FlockClient(flock_url="https://api.theflock.ink") — async context manager
• await c.broadcast(freq, text) → BroadcastResult
• await c.recent(freq, limit=50, since=None) → list[Broadcast]
• c.tune_in(freq) → AsyncIterator[Broadcast] (yields history then live)
• c.firehose() → AsyncIterator[Broadcast]
• derive_frequency(key_bytes) → @XXXX.XXXX.XXXX

tune_in and firehose auto-reconnect with exponential backoff. Pass reconnect=False to exit on disconnect instead.

License

MIT.