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.22.0.tar.gz (246.8 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.22.0-py3-none-any.whl (389.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for trycourier-7.22.0.tar.gz
Algorithm Hash digest
SHA256 47bd140eb0a0140842e8580398f3f5e269b8b2f8a06722777b519671651f0c0a
MD5 070f8d03970a9c6052537383b31514c0
BLAKE2b-256 4f9840267bae228251f9910894b5b18d92094a1040fe88bbe0eac0d2ce51ed7e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trycourier-7.22.0-py3-none-any.whl
  • Upload date:
  • Size: 389.7 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.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7a8f251e96f2ac03127f1d330dc3adb5026461a7dbccb476da33a03b263d2ff2
MD5 3ac90c6319ba1217dd523888dc2c1c7b
BLAKE2b-256 8b4affe597b3ca1af233c773c11b2d7da9122975083ad99a041da2ee5d3db275

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