Welcome to the Bitcaster SDK
The Bitcaster SDK is the official Python client library for the Bitcaster ⧉ notification platform.
It provides a simple, Pythonic interface to interact with the Bitcaster REST API — allowing you to trigger events, manage occurrences, and integrate Bitcaster into any Python or Django application with minimal effort.
Features
- Simple REST client for the Bitcaster API
- Django integration helpers
- CLI interface via
bitcastercommand - Support for Python 3.10+
Quick Start
Install the SDK:
pip install bitcaster-sdk
Trigger an event:
from bitcaster_sdk.client import Client
client = Client("https://<API_KEY>@<SERVER>/api/o/<organization_slug>/")
client.set_domain("my-project", "my-app")
client.trigger_event("my-event", context={"message": "Hello from the SDK!"})
You can also pass project and application at construction time:
client = Client("https://<API_KEY>@<SERVER>/api/o/<org>/", project="my-project", application="my-app")
client.trigger_event("my-event", context={"message": "Hello from the SDK!"})