cadbuildr-broker 0.2.0

WebRTC broker for CADbuildr - mediates communication between foundation library and viewer

CADbuildr Broker

WebRTC broker for CADbuildr that mediates communication between Foundation and a viewer page.

Status

green

Runtime contract

The broker is local-first. Keep heavy CAD data local.

• Data path (heavy): Foundation -> local broker /send -> WebRTC DataChannel -> viewer.
• Signaling path (lightweight): viewer/broker offer-answer exchange via signaling API.
• Signaling can be local or remote/authenticated.
• The broker does not need to relay CAD DAG payloads through cloud endpoints.

Installation

From PyPI

pip install cadbuildr-broker

From monorepo (development)

cd py/packages/broker
poetry install

Usage

Start with local signaling (Hub on localhost):

cadbuildr-broker

Equivalent monorepo command:

cd py/packages/broker
poetry run cadbuildr-broker

Use remote signaling (for example hosted Hub viewer API):

cadbuildr-broker \
  --signaling-base-url https://hub.cadbuildr.com/api/webrtc

Use remote signaling with auth:

CADBUILDR_SIGNALING_BEARER_TOKEN="<token>" \
cadbuildr-broker \
  --signaling-base-url https://hub.cadbuildr.com/api/webrtc

CLI options

• --host: signaling host (default: localhost)
• --port: signaling port (default: 3000)
• --signaling-scheme: http or https (default: http)
• --signaling-base-url: full signaling API base URL, for example https://hub.cadbuildr.com/api/webrtc
• --auth-bearer-token: optional bearer token for signaling requests (or use env CADBUILDR_SIGNALING_BEARER_TOKEN)
• --broker-port: local HTTP port used by Foundation and screenshot upload (default: 5000)

What runs where

1. Broker polls signaling API for offers.
2. Viewer creates WebRTC offer and receives answer.
3. Foundation posts DAG to broker /send on localhost.
4. Broker forwards DAG to viewer via DataChannel.
5. Viewer posts screenshots/log payloads back to broker.

Publishing

Recommended release flow:

cd py/packages/broker
poetry build
poetry publish --repository testpypi
pip install -i https://test.pypi.org/simple cadbuildr-broker
poetry publish

If your environment uses token-based publishing, configure Poetry credentials before publishing.