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.13.0.tar.gz (221.7 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.13.0-py3-none-any.whl (351.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for trycourier-7.13.0.tar.gz
Algorithm Hash digest
SHA256 7b4aeb3efe3d99a84af259607acf5a2a14c8e6c5b1a1274560aafcdbaa4620f6
MD5 1145a3500a99f95efd093e97678ca14b
BLAKE2b-256 abdc9433332b14c4cfd971c2ac6b5a836160a2f026e0bc6aabe248a2f36732a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trycourier-7.13.0-py3-none-any.whl
  • Upload date:
  • Size: 351.6 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.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e51558affe7092f6c0ce52873b7aa9ff0d700583a0dcefa92e93f655581b5010
MD5 c02e31328970c635da0e041e5956433f
BLAKE2b-256 1f2c867b93f95d5cc34c0308b24b41ba9cd8a747a60ac00f7244360e2a810eee

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