basalam.hermes-messaging-sdk 0.0.7

Python SDK to integrate and interact with Hermes Marketing Automation Platform

Hermes Messaging SDK

A lightweight Python SDK for integrating with the Hermes Marketing Automation Platform. This SDK provides both synchronous and asynchronous clients for triggering workflows.

Features

• 🚀 Simple API: Easy-to-use client for triggering workflows
• ⚡ Async Support: Full async/await support for high-performance applications
• 🔄 Retry Logic: Built-in exponential backoff retry mechanism
• 🛡️ Error Handling: Comprehensive error handling with custom exceptions

Installation

pip install basalam.hermes-messaging-sdk

Quick Start

Synchronous Usage

from basalam.hermes_messaging_sdk import HermesClient

# Initialize the client
client = HermesClient(access_token="your-access-token-here")

# Trigger a single workflow
trigger_uuid = client.trigger_workflow(
    workflow_id=123,
    data={
        "user_id": 456,
        "product_id": "abc123"
    }
)
print(trigger_uuid)

# Bulk trigger workflows
trigger_uuids = client.bulk_trigger_workflow(
    workflow_id=123,
    triggers=[
        {"user_id": 456, "amount": "10,000,000"},
        {"user_id": 789, "amount": "1,000,000"}
    ]
)
print(trigger_uuids)

Asynchronous Usage

import asyncio
from basalam.hermes_messaging_sdk import AsyncHermesClient

async def main():
    client = AsyncHermesClient(access_token="your-access-token")

    # Trigger a single workflow
    trigger_uuid = await client.trigger_workflow(
        workflow_id=123,
        data={
            "user_id": 456,
            "product_id": "abc123"
        }
    )
    print(trigger_uuid)

    # Bulk trigger workflows
    trigger_uuids = await client.bulk_trigger_workflow(
        workflow_id=456,
        triggers=[
            {"user_id": 789, "amount": "10,000,000"},
            {"user_id": 101, "amount": "4,000,000"}
        ]
    )
    print(trigger_uuids)

asyncio.run(main())

Configuration

Both HermesClient and AsyncHermesClient support the following configuration options:

client = HermesClient(
    access_token="your-access-token",      # Required: Your Hermes API token ("Bearer " prefix is accepted)
    base_url="https://hermes.basalam.com", # Optional: Custom base URL
    timeout=30,                           # Optional: Request timeout in seconds
    max_retries=3,                        # Optional: Maximum retry attempts
    retry_delay=1.0                       # Optional: Base delay for exponential backoff
)

Retry Configuration

The SDK includes built-in retry logic with exponential backoff:

• max_retries: Number of retry attempts (default: 3)
• retry_delay: Base delay in seconds (default: None, disabled)
• When enabled, uses exponential backoff: retry_delay * (2 ** attempt)

API Responses

Trigger methods return trigger tracking UUIDs extracted from Hermes responses.

Single trigger returns a UUID string:

"trigger-tracking-uuid"

Bulk trigger returns UUID strings in the same order as the input triggers list:

[
    "first-trigger-tracking-uuid",
    "second-trigger-tracking-uuid"
]

If Hermes returns an HTTP error or a successful response without the expected UUID fields, the SDK raises a Hermes exception.

Error Handling

The SDK provides comprehensive error handling with custom exceptions:

from basalam.hermes_messaging_sdk import (
    HermesClient,
    HermesError,
    HermesAPIError,
    HermesConnectionError,
    HermesAuthorizationError
)

try:
    client = HermesClient(access_token="invalid-token")
    client.trigger_workflow(workflow_id=123, data={"test": "data"})
except HermesAuthorizationError as e:
    print(f"Authorization failed: {e}")
    print(f"Status code: {e.status_code}")
except HermesAPIError as e:
    print(f"API error: {e}")
    print(f"Status code: {e.status_code}")
except HermesConnectionError as e:
    print(f"Connection error: {e}")
except HermesError as e:
    print(f"Hermes SDK error: {e}")

API Reference

HermesClient

Methods:

• trigger_workflow(workflow_id, **kwargs) - Trigger a single workflow and return its tracking UUID string
• bulk_trigger_workflow(workflow_id, triggers) - Trigger multiple workflows and return tracking UUID strings in input order

AsyncHermesClient

Async Methods:

• async trigger_workflow(workflow_id, **kwargs) - Trigger a single workflow and return its tracking UUID string
• async bulk_trigger_workflow(workflow_id, triggers) - Trigger multiple workflows and return tracking UUID strings in input order

Requirements

• Python 3.8+
• httpx 0.24.0+

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

• 🐛 Issues: GitHub Issues