Skip to main content

The official Python library for the Courier API

Project description

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

Project details


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

trycourier-7.21.0.tar.gz (239.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.21.0-py3-none-any.whl (378.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trycourier-7.21.0.tar.gz
  • Upload date:
  • Size: 239.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.21.0.tar.gz
Algorithm Hash digest
SHA256 657021a5014a0e0a749df7ac7e521a3758a4a512915396fa4ffa0631e6687c50
MD5 649bd8697d183a31ccb8c9517406fee1
BLAKE2b-256 2a70423106996e714f1e77a78fb640f18baa5f5f7457eceecb350e839f2b8954

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trycourier-7.21.0-py3-none-any.whl
  • Upload date:
  • Size: 378.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.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83f5c14effc4c652762cf97c7a9bb67ef040222401328f4e1d7baea7b5e26122
MD5 5627d0b484240ae129d7169a04f84bd6
BLAKE2b-256 143883d66e118a9db7003167eddde8a1089a6c32dcc6059374c1fbfb6e5768cf

See more details on using hashes here.

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