Bitcaster Python SDK
Python client for the Bitcaster event notification platform.
Quick start
Set your Bitcaster API endpoint:
export BITCASTER_BAE=https://<API_KEY>@<SERVER>/api/o/<organization_slug>/
Sync client
from bitcaster_sdk import Client
client = Client("https://<API_KEY>@<SERVER>/api/o/<organization_slug>/")
client.set_domain("my-project", "my-app")
result = client.trigger_event("order.created", context={"id": "abc-123"})
print(result)
users = client.list_users()
events = client.list_events("my-project", "my-app")
projects = client.list_projects()
Async client (non-blocking)
from bitcaster_sdk import AsyncClient
with AsyncClient("https://<API_KEY>@<SERVER>/api/o/<organization_slug>/") as client:
client.set_domain("my-project", "my-app")
future = client.trigger_event("order.created", context={"id": "abc-123"})
result = future.result(timeout=10)
print(result)
The async client runs HTTP requests on a background thread. The context manager ensures clean shutdown.
Module-level API (quick scripts)
import bitcaster_sdk
bitcaster_sdk.init() # reads BITCASTER_BAE env var
bitcaster_sdk.set_domain("my-project", "my-app")
result = bitcaster_sdk.trigger_event("order.created")
users = bitcaster_sdk.list_users()
CLI
# Check connectivity
bitcaster ping
# Trigger an event
bitcaster trigger --project my-project --application my-app event-slug \
--context order_id abc-123
# List resources
bitcaster projects
bitcaster applications --project my-project
bitcaster events --project my-project --application my-app
bitcaster users list
# Start a fake dev server
bitcaster serve --port 9000
See the CLI reference for full documentation.
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 bitcaster_sdk-0.4.tar.gz.
File metadata
- Download URL: bitcaster_sdk-0.4.tar.gz
- Upload date:
- Size: 17.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a2eceb4f638580b416817a4ce78305de7b3f381d50dc14d44cc63fca73e2c872
|
|
| MD5 |
ff41b7f0ca7621ab8b515cef9575e43e
|
|
| BLAKE2b-256 |
a5bb1127ba4dff32c5374209f7e99f3632297dc90b62d16ac894a3482c3f22cb
|
Provenance
The following attestation bundles were made for bitcaster_sdk-0.4.tar.gz:
Publisher:
release.yml on bitcaster-io/bitcaster-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bitcaster_sdk-0.4.tar.gz -
Subject digest:
a2eceb4f638580b416817a4ce78305de7b3f381d50dc14d44cc63fca73e2c872 - Sigstore transparency entry: 2476628983
- Sigstore integration time:
-
Permalink:
bitcaster-io/bitcaster-sdk@f29452792aa77ef490ca994e0b3a387de0dcddeb -
Branch / Tag:
refs/tags/0.4 - Owner: https://github.com/bitcaster-io
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@f29452792aa77ef490ca994e0b3a387de0dcddeb -
Trigger Event:
push
-
Statement type:
File details
Details for the file bitcaster_sdk-0.4-py3-none-any.whl.
File metadata
- Download URL: bitcaster_sdk-0.4-py3-none-any.whl
- Upload date:
- Size: 24.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb2f34d472ddcb642dda7d557a889dafacdfb266500d9ff775c6177ca9131814
|
|
| MD5 |
a31247d10dc11c6705a92651287e5bcd
|
|
| BLAKE2b-256 |
e273ca9c0ae57a0f50e8f7a8e100e4e1ab4285370fc981a1a149bd8b763e3c3b
|
Provenance
The following attestation bundles were made for bitcaster_sdk-0.4-py3-none-any.whl:
Publisher:
release.yml on bitcaster-io/bitcaster-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bitcaster_sdk-0.4-py3-none-any.whl -
Subject digest:
cb2f34d472ddcb642dda7d557a889dafacdfb266500d9ff775c6177ca9131814 - Sigstore transparency entry: 2476629036
- Sigstore integration time:
-
Permalink:
bitcaster-io/bitcaster-sdk@f29452792aa77ef490ca994e0b3a387de0dcddeb -
Branch / Tag:
refs/tags/0.4 - Owner: https://github.com/bitcaster-io
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@f29452792aa77ef490ca994e0b3a387de0dcddeb -
Trigger Event:
push
-
Statement type:
