broadcast-python 0.1.0__py3-none-any.whl

broadcast_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,488 @@
+Metadata-Version: 2.4
+Name: broadcast-python
+Version: 0.1.0
+Summary: Python client for the Broadcast email platform. Subscribers, sequences, broadcasts, segments, templates, autopilot, webhooks, and transactional email.
+Project-URL: Homepage, https://sendbroadcast.net
+Project-URL: Repository, https://github.com/send-broadcast/broadcast-python
+Project-URL: Changelog, https://github.com/send-broadcast/broadcast-python/blob/main/CHANGELOG.md
+Author: Simon Chiu
+License: MIT
+License-File: LICENSE
+Keywords: broadcast,email,email-marketing,newsletter,sendbroadcast,transactional
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Email
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# broadcast-python
+
+Official Python client for [Broadcast](https://sendbroadcast.net), the self-hosted email marketing platform.
+
+Works with any Broadcast instance — self-hosted or SaaS. Covers **104/104 API operations**, verified against the API's generated OpenAPI document.
+
+📖 **[Python SDK documentation](https://sendbroadcast.net/docs/python-sdk)** · [API reference](https://sendbroadcast.net/docs/api-authentication) · [All docs](https://sendbroadcast.net/docs)
+
+Also available: [Ruby](https://github.com/send-broadcast/broadcast-ruby) · [PHP](https://github.com/send-broadcast/broadcast-php) · [Node/TypeScript](https://github.com/send-broadcast/broadcast-node)
+
+> **Not yet on PyPI.** The package is complete and tested but unpublished, so
+> `pip install broadcast-python` will not resolve. Install from the repository
+> until it lands:
+>
+> ```bash
+> pip install git+https://github.com/send-broadcast/broadcast-python
+> ```
+
+## Installation
+
+```bash
+pip install broadcast-python
+```
+
+Python 3.9+. **No runtime dependencies** — the transport is built on the
+standard library's `urllib`, so it cannot conflict with a pinned `requests` or
+`httpx` elsewhere in your environment.
+
+The distribution is `broadcast-python`; the module is `broadcast_python`. A
+package named `broadcast` already exists on PyPI, so the module deliberately
+does not claim that name.
+
+## Getting Your API Token
+
+1. Log in to your Broadcast dashboard
+2. Go to **Settings > API Keys**
+3. Click **New API Key**
+4. Name it, select the permissions you need (see [Permissions](#api-token-permissions) below), and save
+5. Copy the token
+
+## Quick Start
+
+```python
+from broadcast_python import Broadcast
+
+client = Broadcast(
+    api_token="...",                  # or BROADCAST_API_TOKEN
+    host="https://mail.example.com",  # or BROADCAST_HOST — required
+)
+
+client.subscribers.create(email="ada@example.com", first_name="Ada")
+
+client.transactionals.create(
+    to="ada@example.com",
+    subject="Welcome",
+    body="<p>Glad you are here.</p>",
+)
+```
+
+### `host` is required
+
+There is no default. Broadcast is self-hosted-first, so every instance lives at
+its own domain and any built-in guess would be wrong for nearly everyone.
+
+`BROADCAST_HOST` and `BROADCAST_API_TOKEN` are the same names the Broadcast CLI
+uses in `~/.config/broadcast/config`, so a machine set up for the CLI needs no
+extra configuration.
+
+---
+
+## Configuration
+
+```python
+Broadcast(
+    api_token="...",
+    host="https://...",
+    timeout=30,              # read timeout, seconds
+    open_timeout=10,
+    retry_attempts=3,
+    retry_delay=1,           # base backoff, multiplied by attempt number
+    max_retry_delay=30,      # ceiling on a server-sent Retry-After
+    warnings_mode="log",     # "log" | "raise" | "ignore"
+    logger=logging.getLogger(__name__),
+    debug=False,
+    broadcast_channel_id=42, # admin/system tokens
+)
+```
+
+A typo in a setting name raises `TypeError` rather than being silently ignored.
+
+---
+
+## Responses
+
+`Response` subclasses `dict`, so a result behaves exactly like the parsed body
+while carrying transport metadata as attributes:
+
+```python
+result = client.subscribers.create(email="ada@example.com")
+
+result["id"]                     # the body
+result.status                    # 201
+result.warnings                  # [Warning_(code=..., param=..., message=...)]
+result.rate_limit.remaining
+result.idempotent_replay         # True if the API replayed a stored response
+```
+
+Item access reads the body, attribute access reads metadata — so a body field
+named `status` (which broadcasts have) stays reachable as `result["status"]`.
+
+---
+
+## Warnings
+
+A 2xx response can carry warnings: the API accepted your request but ignored
+part of it. A mistyped filter silently widens a result set unless you look.
+
+```python
+# "log" (default) — warn through `logger`, return normally
+# "raise"         — raise WarningError. NOTE: the write already happened.
+# "ignore"        — say nothing; read them off result.warnings
+```
+
+---
+
+## Rate Limits
+
+Every response carries the current limit state, and 429s are retried
+automatically, honouring the server's `Retry-After` (capped at `max_retry_delay`).
+
+```python
+result = client.subscribers.list()
+
+result.rate_limit.limit      # 120
+result.rate_limit.remaining  # 118
+result.rate_limit.reset      # datetime
+
+if result.rate_limit and result.rate_limit.remaining < 10:
+    time.sleep(1)
+```
+
+`rate_limit` is `None` when the server sends no limit headers, or when the limit
+header cannot be parsed — a value we cannot read makes the whole block
+untrustworthy.
+
+If the retries are exhausted you get a `RateLimitError`, which carries
+`.retry_after` so you can requeue the job sensibly.
+
+---
+
+## Errors
+
+```
+BroadcastError
+├── ConfigurationError
+├── APIError
+│   ├── AuthenticationError   401
+│   ├── AuthorizationError    403
+│   ├── NotFoundError         404
+│   ├── ConflictError         409  idempotency replay still in flight
+│   └── RateLimitError        429  carries .retry_after
+├── ValidationError           422
+├── TimeoutError
+├── DeliveryError
+└── WarningError                   carries .warnings and .response
+```
+
+`ValidationError` and `TimeoutError` are siblings of `APIError`, not children —
+matching the Ruby gem. Note `broadcast_python.TimeoutError` is **not** the builtin
+`TimeoutError`.
+
+Timeouts, 429s, and 5xx are retried with backoff. A 422 is not: it is
+deterministic, so retrying is pure latency.
+
+---
+
+## Common Tasks
+
+### Subscribers
+
+```python
+client.subscribers.list(page=1, is_active=True, tags=["vip"])
+client.subscribers.find("ada@example.com")
+client.subscribers.create(email="ada@example.com", tags=["vip"])
+client.subscribers.update("ada@example.com", first_name="Ada")
+client.subscribers.add_tags("ada@example.com", ["beta"])
+client.subscribers.remove_tags("ada@example.com", ["beta"])
+client.subscribers.activate("ada@example.com")
+client.subscribers.deactivate("ada@example.com")
+client.subscribers.unsubscribe("ada@example.com")
+client.subscribers.resubscribe("ada@example.com")
+client.subscribers.redact("ada@example.com")   # irreversible
+```
+
+`created_after` / `created_before` that fail to parse are **ignored** by the
+server rather than rejected — they return a `parameter_ignored` warning, so a
+bad timestamp silently widens your result set. Check `result.warnings`.
+
+### Broadcasts
+
+```python
+client.broadcasts.create(subject="Weekly", body="<p>Hi</p>")
+client.broadcasts.send(id)                       # no undo
+client.broadcasts.schedule(id, scheduled_send_at="2026-08-01T09:00:00Z", scheduled_timezone="UTC")
+client.broadcasts.cancel_schedule(id)
+client.broadcasts.statistics(id)
+client.broadcasts.statistics_timeline(id)
+client.broadcasts.statistics_links(id)
+```
+
+### Sequences
+
+```python
+client.sequences.get(id, include_steps=True)
+client.sequences.add_subscriber(id, email="ada@example.com")
+client.sequences.remove_subscriber(id, "ada@example.com")
+client.sequences.create_step(id, subject="Day 1")
+client.sequences.move_step(id, step_id, under_id)
+```
+
+### Segments, templates, opt-in forms
+
+```python
+client.segments.create(name="VIPs")
+client.templates.create(label="Welcome", subject="Hi", body="...")
+client.opt_in_forms.analytics(id, start_date=date(2026, 1, 1))
+client.opt_in_forms.create_variant(id, name="B", weight=50)
+client.opt_in_forms.duplicate(id, label="Copy")
+```
+
+Reading a segment recounts its members server-side, so `segments.get` is not free.
+
+### Email servers
+
+**Credential redaction guard.** The API returns credentials bullet-masked
+(`••••••••`). A naive fetch-modify-save would write those bullets back and
+destroy a working SMTP password. `update()` strips any credential field whose
+value matches the redaction pattern and warns:
+
+```python
+server = client.email_servers.get(id)
+server["smtp_password"]                      # '••••••••'
+client.email_servers.update(id, name="Renamed", smtp_password=server["smtp_password"])
+# -> sends only {"name": "Renamed"}, warns about the dropped field
+```
+
+### Autopilot
+
+```python
+client.autopilots.create(name="Weekly", ai_model="openai/gpt-4o")
+client.autopilots.activate(id)
+client.autopilots.trigger_run(id)     # 202 — async, poll runs()
+client.autopilots.runs(id, limit=10)
+```
+
+`activate` requires an active source, an API key, and a model. Sources and tone
+samples have **no API endpoints** — they live in the web UI, so an autopilot
+created entirely over the API cannot be activated until a source is added there.
+
+### Transactional email
+
+```python
+client.transactionals.create(
+    to="ada@example.com",
+    subject="Receipt",
+    body="<p>Thanks</p>",
+    idempotency_key="receipt-{}".format(order.id),
+)
+```
+
+The server stores the response for 24 hours keyed on (token, key) and replays it
+rather than sending a second email. The key is part of a fingerprint over
+method + path + body:
+
+- same key, same payload, still running → `ConflictError` (409)
+- same key, **different** payload → `ValidationError` (422)
+
+That 422 means "this key was already used for something else", not that the
+email was invalid. Do not retry it with the same key.
+
+This is the only endpoint that accepts `Idempotency-Key`.
+
+### Discovery
+
+```python
+client.whoami()   # token identity and permissions
+client.status()   # channel readiness — check before a send
+client.prime()    # full capability manifest
+client.skill()    # plain-text agent skill manifest (a str)
+```
+
+### Migration / export
+
+Read-only. **Admin tokens only**, and every call needs a `broadcast_channel_id`.
+
+```python
+client = Broadcast(..., broadcast_channel_id=42)
+
+client.migration.manifest()
+
+for sub in client.migration.each_record("subscribers"):
+    ...   # auto-pages; advances by the limit the server actually applied
+
+data = client.migration.download_file_asset(id)   # bytes
+```
+
+On a demo instance this entire API returns **403 for every request**, valid
+token or not — deliberately, so a public demo cannot be used as a token oracle.
+It surfaces as `AuthorizationError`.
+
+---
+
+## Channel Scoping
+
+```python
+with client.with_channel(123):
+    client.email_servers.list()   # scoped to channel 123
+```
+
+The previous scope is restored on exit, including when the block raises. The
+override lives on the client instance, so concurrent use across threads will
+interleave — use one client per thread, or pass `broadcast_channel_id`
+explicitly.
+
+---
+
+## Webhooks
+
+```python
+from broadcast_python import webhook
+
+valid = webhook.verify(
+    raw_body,                        # the raw bytes, not a re-serialised dict
+    request.headers["X-Broadcast-Signature"],
+    request.headers["X-Broadcast-Timestamp"],
+    os.environ["WEBHOOK_SECRET"],
+)
+if not valid:
+    return HttpResponse(status=401)
+```
+
+HMAC-SHA256 over `timestamp.payload`, `v1,<base64>` header format, 5-minute
+timestamp tolerance, constant-time comparison. `verify` returns `False` for
+every rejection rather than distinguishing them.
+
+Pass the **raw** request body. Re-serialising a parsed dict changes the bytes
+and verification will fail.
+
+`broadcast_python.EVENT_TYPES` lists all 32 event names.
+
+---
+
+## API Token Permissions
+
+Each token can be scoped to specific resources. Use the minimum permissions your
+integration requires.
+
+| Resource | Read permission | Write permission |
+|----------|----------------|------------------|
+| Transactional Emails | `transactionals_read` -- get delivery status | `transactionals_write` -- send emails |
+| Subscribers | `subscribers_read` -- list, find | `subscribers_write` -- create, update, tag, deactivate, unsubscribe, redact |
+| Sequences | `sequences_read` -- list, get, list steps | `sequences_write` -- create, update, delete, manage steps, enroll subscribers |
+| Broadcasts | `broadcasts_read` -- list, get, statistics | `broadcasts_write` -- create, update, delete, send, schedule |
+| Segments | `segments_read` -- list, get | `segments_write` -- create, update, delete |
+| Templates | `templates_read` -- list, get | `templates_write` -- create, update, delete |
+| Opt-In Forms | `opt_in_forms_read` -- list, get, analytics | `opt_in_forms_write` -- create, update, delete, create_variant, duplicate |
+| Email Servers | `email_servers_read` -- list, get | `email_servers_write` -- create, update, delete, test_connection, copy_to_channel (admin) |
+| Webhook Endpoints | `webhook_endpoints_read` -- list, get, deliveries | `webhook_endpoints_write` -- create, update, delete, test |
+| Autopilot | `autopilot_read` -- list, get, runs | `autopilot_write` -- create, update, delete, activate, pause, deactivate, trigger_run |
+
+---
+
+## Troubleshooting
+
+### `AuthenticationError` (401)
+
+- **Check the token:** it must be an API key from **Settings > API Keys**, not a
+  password or a session cookie.
+- **Check the host:** pointing at the wrong instance produces a valid-looking
+  401, because the token is unknown there.
+
+### `AuthorizationError` (403)
+
+The token is valid but lacks the permission for that call. Check the table
+above, then re-issue the key with the resource enabled — permissions are fixed
+at creation.
+
+On a demo instance, the entire migration API returns 403 for every request,
+valid token or not.
+
+### `ValidationError` (422) on a repeated send
+
+If you reused an `idempotency_key` with a *different* payload, the API rejects
+it: the key is fingerprinted over method, path and body. It means "this key was
+already used for something else", not that the email was invalid. Use a new key.
+
+### Emails accepted but never delivered
+
+Call `client.status()`. If `readiness["transactionals"]` is false, the channel
+has no usable email server or sender identity — the API accepts the request and
+the send stalls. On a demo instance, sends are always accepted and never
+delivered.
+
+### `APIError` mentioning a redirect
+
+Your `host` is wrong — usually `http` instead of `https`, or a bare apex that
+redirects to `www`. The client refuses to follow redirects on writes, and never
+across hosts, because every request carries your API token. Set `host` to the
+final URL.
+
+### `TimeoutError` is not the builtin
+
+`broadcast_python.TimeoutError` mirrors the Ruby gem's error hierarchy and is a
+distinct class from Python's builtin. `except TimeoutError` in a module that
+imported ours will not catch a socket timeout, and vice versa.
+
+---
+
+## Development
+
+```bash
+python -m unittest discover -s tests    # mocked HTTP, no network
+
+pip install ruff mypy
+ruff check .
+mypy
+
+BROADCAST_LIVE_TEST=1 BROADCAST_HOST=http://localhost:3000 \
+BROADCAST_API_TOKEN=... python -m unittest tests.test_live
+```
+
+The suite uses only the standard library — no pytest required, and no install
+step: `PYTHONPATH=src:tests` is the whole setup.
+
+CI runs the suite on Python 3.9 through 3.14, lints with ruff, type-checks with
+mypy, and separately builds the wheel and installs it into a clean virtualenv to
+prove the packaged artifact imports and works.
+
+---
+
+## Documentation
+
+- **[Python SDK guide](https://sendbroadcast.net/docs/python-sdk)** — the same material as this README, on the docs site
+- **[API reference](https://sendbroadcast.net/docs/api-authentication)** — endpoints, parameters, and permissions
+- **[API response warnings](https://sendbroadcast.net/docs/api-response-warnings)** — why a 2xx can still tell you something went wrong
+- **[Webhook endpoints](https://sendbroadcast.net/docs/api-webhook-endpoints)** — signature format and event types
+- **[Agents CLI](https://sendbroadcast.net/docs/agents-cli)** — the same credentials, from a terminal
+
+### Other SDKs
+
+| Language | Package | Repository |
+|---|---|---|
+| Python | broadcast-python | this repository |
+| Ruby | [broadcast-ruby](https://rubygems.org/gems/broadcast-ruby) | [broadcast-ruby](https://github.com/send-broadcast/broadcast-ruby) |
+| PHP | [broadcast/broadcast-php](https://packagist.org/packages/broadcast/broadcast-php) | [broadcast-php](https://github.com/send-broadcast/broadcast-php) |
+| Node / TypeScript | [@send-broadcast/sdk](https://www.npmjs.com/package/@send-broadcast/sdk) | [broadcast-node](https://github.com/send-broadcast/broadcast-node) |
+
+All four cover the same 104 operations and behave the same way on the wire — the transport contract (warnings, idempotency, rate-limit handling, redirect safety, credential redaction) is identical across languages.
+
+---
+
+## License
+
+MIT

broadcast_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,27 @@
+broadcast_python/__init__.py,sha256=_mzCFewxAEutE4fJ7hRPpaHuQwXpliHt5BNRE-J80TY,1632
+broadcast_python/client.py,sha256=LNlD_iFiaWsVigOJTfjgJrm5nKY5rV9KrMZZK2EsyNM,4587
+broadcast_python/configuration.py,sha256=kXheoYhwRJo6STIL9Wmhl_MOEdWfaV3CBETEh1SbEcI,3961
+broadcast_python/connection.py,sha256=cAXyfwJ1pdleLm7S9fr1FUk5nqkdOTdav6dGZGJ0GfU,14064
+broadcast_python/errors.py,sha256=NFJ69Oy_FtYZ3-BEq8Q1m5wLqcufRZLPDYuJlgBfGpc,1993
+broadcast_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+broadcast_python/response.py,sha256=fIBzxi4a2Sc7sNSOb2_t85Y3Opdet89uNbHM5CX3YXw,5511
+broadcast_python/version.py,sha256=WmWlkCJx3Rc5Kvlunmbdy7yVhhrpLaWiUyOhAKeVEnQ,169
+broadcast_python/webhook.py,sha256=_6_QC0p6beNmw5FBMcD_ZBhLhDMtEGfsIqp_JfnybtM,3540
+broadcast_python/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+broadcast_python/resources/autopilots.py,sha256=yDXs7lPi2tqJwPEi_e156jRFQIkVamsdvYGiHax_7HM,3416
+broadcast_python/resources/base.py,sha256=MCnzyu4oNdMe0a9sccQIG_en017EAVk2hx31R8-Whvg,1493
+broadcast_python/resources/broadcasts.py,sha256=VuYkKJ3d3mcaShXciMqAPHH-OT8px559VeXNltqkx3A,1954
+broadcast_python/resources/discovery.py,sha256=2_TOfuPKAmQc63AGzBp61qhVBmCJdIYxeV5GlcS7YYs,1347
+broadcast_python/resources/email_servers.py,sha256=1_ZJEPwVjFi5rN6S_0n7WfFfmF5y3JDIcW0Ixak0Z24,2830
+broadcast_python/resources/migration.py,sha256=y-GqY4BWzdNnlc6TWu7wNmqcqzEWSroxva1KiMqAJQg,4099
+broadcast_python/resources/opt_in_forms.py,sha256=ScoEKXejT27UfTL8iGxlsADO6g5Q-4xCpWOFtmM6q2E,2509
+broadcast_python/resources/segments.py,sha256=ZfUJxiWPhERWzkzuRGVu09uWqbwyUbdr3NsKOEeuW8o,857
+broadcast_python/resources/sequences.py,sha256=9IuKw13e_LYZMLZiBYrr0b-BPhAAAucdt8DUjQvbP80,2467
+broadcast_python/resources/subscribers.py,sha256=DtUnHs1rj3LF7KACQRQFB-ofgAHl1WTiLluL4W7xbfw,3168
+broadcast_python/resources/templates.py,sha256=FP0KcP61KkfrRID1XeAQ8hRxxRyxBzt404nXmnBqXNY,1262
+broadcast_python/resources/transactionals.py,sha256=iwe9aTHKpeEMtDxd_S2TVzdUVm5Phno-Vinrxu9bn6w,2940
+broadcast_python/resources/webhook_endpoints.py,sha256=Llkry10QT3JavkmKok3IAayYKM1PD1-iI51YhW3RbpE,1180
+broadcast_python-0.1.0.dist-info/METADATA,sha256=dRJ8wybrA98MkCFbiA91AmnHtXA3-2L1vleZ19-t2bY,17580
+broadcast_python-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+broadcast_python-0.1.0.dist-info/licenses/LICENSE,sha256=cnoPKJuOFIyR8mBe7kmEcUQelniJaujjGl21QWqzlKE,1067
+broadcast_python-0.1.0.dist-info/RECORD,,

broadcast_python-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

broadcast_python-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Simon Chiu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.