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.10.0.tar.gz (200.2 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.10.0-py3-none-any.whl (308.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for trycourier-7.10.0.tar.gz
Algorithm Hash digest
SHA256 d690f9a988899569f5a5853319bb8efff923d1e77333347ad15ed1daba817eba
MD5 dacddbe36ba747ddc9f928311a9888bf
BLAKE2b-256 5afb2df48a58a938bc696b6264d5b7ef676ccfa07bd2ef96af21e909e06c2c36

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trycourier-7.10.0-py3-none-any.whl
  • Upload date:
  • Size: 308.3 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.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24b78d6f31972491674bc3f5a9bb9dca011452804105a833c128792ff8f644fb
MD5 31b7acce9dd880d56bc334f85b86aeea
BLAKE2b-256 7fe4a2512ce27b139c6f51b3a17b46249bff51880e5aba19e352195924f45dee

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