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.9.0.tar.gz (180.6 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.9.0-py3-none-any.whl (272.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for trycourier-7.9.0.tar.gz
Algorithm Hash digest
SHA256 e3b31fd565f571e69b1b8109849edd96245b103dde582777798d8d9f628d9b53
MD5 af26bdb7b789ba2af773ad81b1f155b1
BLAKE2b-256 c98b8089597272c7ca8476e2e04cd38ffd66d257a75d5001f8b281521b1c2c2a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trycourier-7.9.0-py3-none-any.whl
  • Upload date:
  • Size: 272.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.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 945a57b99b67675374eb40df3dd7ee1110371c2bae7138d1d78f801854d014e8
MD5 a0f7404d437016a5f6968bdb1f7eaa9c
BLAKE2b-256 8ded4721f9a0c695b38b9f03ec5d048f4ef2d4030067d1ae18d4a39b8772cfc0

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