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.1.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.1-py3-none-any.whl (387.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trycourier-7.19.1.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.1.tar.gz
Algorithm Hash digest
SHA256 9570ddfe8fa3500ac2a7a5c0af51178302b20b55aa9426a852e7f95ab19b6f85
MD5 27e46d1bc9bda87096d2f8f920dd9ddc
BLAKE2b-256 d800dcc9f9121446e7291264303334db20b209a38f994135bb2d9915f02211b7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trycourier-7.19.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4c3baa8a43166092e9725427a654bf9b58fc6a9b5bec4440d31c5263cc5d8a27
MD5 40a87ee130c5cbdb22acbd8c3e9a2bb9
BLAKE2b-256 d3b709e92b64cb5d4cf86c374e29c5aa6b65d684d717793e5255305fc158024e

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