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.19.0.tar.gz (242.4 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.19.0-py3-none-any.whl (387.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for trycourier-7.19.0.tar.gz
Algorithm Hash digest
SHA256 2bc5f5c79e2c6dc94da696e669fd35223548e3c994111c27b644fd8e461cd20d
MD5 04e7d775c67cc734eaa400da90312cd1
BLAKE2b-256 95ebd6e8b8850ded003b496059e42515043683590968cca83c3b22b674bea40e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trycourier-7.19.0-py3-none-any.whl
  • Upload date:
  • Size: 387.0 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.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e240110a2efaee3e3789c68c2fe78392e13a5e31ef1c23a984232d1bbc4bdb56
MD5 2345a13e6511d6ee3044263a5132728d
BLAKE2b-256 87bbd08106a15da1305bdb7a082870e14cd423e6bb229a05310c8d504712ed64

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