Skip to main content

Courier Python SDK

The Courier Python SDK provides typed access to the Courier REST API from any Python 3.9+ application. It includes synchronous and asynchronous clients, Pydantic response models, TypedDict request params, and automatic retries.

Installation

pip install trycourier

Also available via poetry add trycourier and pipenv install trycourier.

Quick Start

from courier import Courier

client = Courier()

response = client.send.message(
    message={
        "to": {"email": "you@example.com"},
        "content": {
            "title": "Hello from Courier!",
            "body": "Your first notification, sent with the Python SDK.",
        },
    },
)

print(response.request_id)

The client reads COURIER_API_KEY from your environment automatically. You can also pass it explicitly: Courier(api_key='your-key').

Async usage

Import AsyncCourier instead of Courier and use await:

import asyncio
from courier import AsyncCourier

client = AsyncCourier()

async def main():
    response = await client.send.message(
        message={
            "to": {"email": "you@example.com"},
            "content": {
                "title": "Hello from Courier!",
                "body": "Sent from the async Python client.",
            },
        },
    )
    print(response.request_id)

asyncio.run(main())

Common Operations

# Check message delivery status
message = client.messages.retrieve("message-id")
print(message.status)

# Create or update a user profile
client.profiles.create("user_123", profile={
    "email": "jane@example.com",
    "name": "Jane Doe",
})

# Issue a JWT for client-side SDK auth
result = client.auth.issue_token(
    scope="user_id:user_123 inbox:read:messages inbox:write:events",
    expires_in="2 days",
)

Documentation

Full documentation: courier.com/docs/sdk-libraries/python

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trycourier-7.24.0.tar.gz (252.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

trycourier-7.24.0-py3-none-any.whl (396.9 kB view details)

Uploaded Python 3

File details

Details for the file trycourier-7.24.0.tar.gz.

File metadata

  • Download URL: trycourier-7.24.0.tar.gz
  • Upload date:
  • Size: 252.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.9

File hashes

Hashes for trycourier-7.24.0.tar.gz
Algorithm Hash digest
SHA256 5a2c5976621d2080321d82dfe226158eb7dfc5eacb6682ac9ba55df23151d960
MD5 4b477c91f4baccc096f6bc3c31d32818
BLAKE2b-256 8845fb5e6cb32ee399d463f9ea315cfcbf7d6a739178b7a47531e97d156be7ca

See more details on using hashes here.

File details

Details for the file trycourier-7.24.0-py3-none-any.whl.

File metadata

  • Download URL: trycourier-7.24.0-py3-none-any.whl
  • Upload date:
  • Size: 396.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.9

File hashes

Hashes for trycourier-7.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b624a23c39468b15a66792687efc1b833b16ae9d54a53d176f29cdb0f044f4d4
MD5 6f2999bcd9c594502e719578d98ec296
BLAKE2b-256 676dc6a2875d45d2fe8292594f0dc81701f76dc47fa850083b4b2d9fe745a484

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page