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.25.0.tar.gz (253.6 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.25.0-py3-none-any.whl (397.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for trycourier-7.25.0.tar.gz
Algorithm Hash digest
SHA256 a7671e781585d5481095617bd40760780088eb122c7f6dd350ae481b4991c921
MD5 cdae36af05f022a681ccc466a30d970b
BLAKE2b-256 049ba853c120920c98345006b117da66c795059375808028a60fc12474bf6082

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trycourier-7.25.0-py3-none-any.whl
  • Upload date:
  • Size: 397.5 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.25.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bdd5d1cd97d9c9d4c6fcb4e2448870c185b8407fbf2e04ee029943aa53e4f8f3
MD5 bd9c4ea87c6578366988430ed2d4686f
BLAKE2b-256 32318b55b1673f44c975274f258313099fb67b57846dd30ef217238c063fe50c

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