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.15.0.tar.gz (225.5 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.15.0-py3-none-any.whl (359.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for trycourier-7.15.0.tar.gz
Algorithm Hash digest
SHA256 1f5b69bae2ecebbff69e8f582be3c930439ef52913f5251573cb178bed3d63eb
MD5 b1fd0ba20b670221fb2ffeed6d5c9af0
BLAKE2b-256 f54ea5d9c7fa15dbdd8b1ef875ecadd29b62df433b10ad0e814167e92baf442e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trycourier-7.15.0-py3-none-any.whl
  • Upload date:
  • Size: 359.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.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2bebf5744776f6a6b255d9d7a4ad585abb8a85229aa53dbdfe35741616e1d9d3
MD5 0778230ee8dd526cdb74f493d41ab88d
BLAKE2b-256 49ec3d2f808cd1b86cbaa41f8e59a28ee54c8f3dc50ac65d812a622c70e0bf0a

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