Borgee Plugin SDK for Python

borgee-plugin-sdk connects a Python runtime to Borgee over the Borgee Plugin Protocol (BPP). It supports Python 3.11 through 3.13 and pins websockets==15.0.1 because the connection hardening depends on that exact client implementation.

Build a wheel from this directory or install the source checkout for evaluation. The repository also provides a manual workflow for publishing to TestPyPI and PyPI.

python -m pip install .

import asyncio

from borgee_plugin_sdk import BorgeePluginOptions, ReplayMode, create_borgee_plugin


async def main() -> None:
    client = create_borgee_plugin(
        BorgeePluginOptions(
            base_url="https://chat.example.com",
            api_key="bgr_example",
            replay_mode=ReplayMode.LATEST_N,
        )
    )
    async with client:
        async for delivery in client.deliveries():
            print(delivery.event)
            await delivery.checkpoint()


asyncio.run(main())

Every inbound message or replay summary is a Delivery. The iterator has one consumer, and it will not advance until the consumer calls checkpoint() or fail(). Actions fail while the connection is resuming; replay consumption continues until the client becomes online.

For local development, insecure transport is restricted to loopback origins and requires allow_insecure_loopback=True. API keys are sent only in the WebSocket Authorization header. Redirects are rejected.

This package is licensed under the MIT License.