No project description provided
Project description
Brevo Python SDK
Website · API Reference · Support
Official SDK for the Brevo API.
Table of Contents
- Documentation
- Installation
- Reference
- Migration From V1X
- Usage
- Async Client
- Exception Handling
- Advanced
Documentation
API reference documentation is available here.
Installation
pip install brevo
Reference
A full reference for this library is available here.
Migration from v1.x
Warning: The legacy v1.x SDK (
brevo-python< 4.0) will continue to receive critical security updates but no new features. We recommend migrating to v4.x.
View migration guide
Key changes:
- New client initialization via
Brevo(api_key="...") - Native async support with
AsyncBrevo - Pydantic-based typed models
- Automatic retries with exponential backoff
httpxreplacesurllib3
v1.x:
import brevo_python
from brevo_python.rest import ApiException
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
api_instance = brevo_python.AccountApi(brevo_python.ApiClient(configuration))
api_response = api_instance.get_account()
v4.x:
from brevo import Brevo
client = Brevo(api_key="YOUR_API_KEY")
account = client.account.get_your_account_information_plan_and_credits_details()
| Area | v1.x (brevo_python) |
v4.x (brevo) |
|---|---|---|
| Module | import brevo_python |
from brevo import Brevo |
| Client | AccountApi(ApiClient(config)) |
Brevo(api_key="...") |
| Errors | ApiException |
ApiError with .status_code, .body |
| HTTP | urllib3 |
httpx |
| Async | Not available | AsyncBrevo |
| Retries | Not built-in | Automatic with exponential backoff |
| Python | 2.7, 3.4+ | 3.8+ |
Usage
Instantiate and use the client with the following:
from brevo import Brevo
from brevo.transactional_emails import (
SendTransacEmailRequestSender,
SendTransacEmailRequestToItem,
)
client = Brevo(
api_key="YOUR_API_KEY",
)
client.transactional_emails.send_transac_email(
html_content="<html><head></head><body>Your delivery is expected {{params.estimatedArrival}}.Your tracking code: {{params.trackingCode}}</p></body></html>",
params={
"trackingCode": "JD01460000300002350000",
"estimatedArrival": "Tomorrow",
},
sender=SendTransacEmailRequestSender(
email="hello@brevo.com",
name="Alex from Brevo",
),
subject="Hello from Brevo!",
to=[
SendTransacEmailRequestToItem(
email="johndoe@example.com",
name="John Doe",
)
],
)
Async Client
The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).
import asyncio
from brevo import AsyncBrevo
from brevo.transactional_emails import (
SendTransacEmailRequestSender,
SendTransacEmailRequestToItem,
)
client = AsyncBrevo(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.transactional_emails.send_transac_email(
html_content="<html><head></head><body>Your delivery is expected {{params.estimatedArrival}}.Your tracking code: {{params.trackingCode}}</p></body></html>",
params={
"trackingCode": "JD01460000300002350000",
"estimatedArrival": "Tomorrow",
},
sender=SendTransacEmailRequestSender(
email="hello@brevo.com",
name="Alex from Brevo",
),
subject="Hello from Brevo!",
to=[
SendTransacEmailRequestToItem(
email="johndoe@example.com",
name="John Doe",
)
],
)
asyncio.run(main())
Exception Handling
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.
from brevo.core.api_error import ApiError
try:
client.transactional_emails.send_transac_email(...)
except ApiError as e:
print(e.status_code)
print(e.body)
Advanced
Access Raw Response Data
The SDK provides access to raw response data, including headers, through the .with_raw_response property.
The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.
from brevo import Brevo
client = Brevo(
...,
)
response = client.transactional_emails.with_raw_response.send_transac_email(...)
print(response.headers) # access the response headers
print(response.status_code) # access the response status code
print(response.data) # access the underlying object
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
Use the max_retries request option to configure this behavior.
client.transactional_emails.send_transac_email(..., request_options={
"max_retries": 1
})
Timeouts
The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
from brevo import Brevo
client = Brevo(
...,
timeout=20.0,
)
# Override timeout for a specific method
client.transactional_emails.send_transac_email(..., request_options={
"timeout_in_seconds": 1
})
Custom Client
You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies
and transports.
import httpx
from brevo import Brevo
client = Brevo(
...,
httpx_client=httpx.Client(
proxy="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
Release history Release notifications | RSS feed
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 brevo_python-4.0.10.tar.gz.
File metadata
- Download URL: brevo_python-4.0.10.tar.gz
- Upload date:
- Size: 428.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.9.25 Linux/6.17.0-1010-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3ba2808937556b02d7afe4aaf6392438e1af3a8db77ef97349e46307bbf27311
|
|
| MD5 |
544196495a7ef558c9b80ad3486dbcb7
|
|
| BLAKE2b-256 |
9279573272ac0ac158e5498690daf06452fbca1785dcd1f85bdcb7bcda86d090
|
File details
Details for the file brevo_python-4.0.10-py3-none-any.whl.
File metadata
- Download URL: brevo_python-4.0.10-py3-none-any.whl
- Upload date:
- Size: 877.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.9.25 Linux/6.17.0-1010-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4fb38f4143ce2c440b35e574696f2ae667cf6454d592409af7750eb675703de0
|
|
| MD5 |
2bc0f1f34b79c92485862f7e3a73ca61
|
|
| BLAKE2b-256 |
adb7cf28d6ac954cc98f2f5297f52bc57f3032f6360e0ad77d1fb36518ef4691
|
