opensend 0.1.0

Python SDK for the OpenSend email API

opensend Python SDK

Minimal first-party Python SDK for OpenSend transactional email sends with a familiar email API surface.

Use your OpenSend API key (os_...) with OpenSend as a Resend alternative. The SDK keeps selected alias compatibility for migration-oriented code.

Installation

From this repository before the PyPI release:

python -m pip install ./packages/python-sdk

After opensend==0.1.0 is published to PyPI, install with:

python -m pip install opensend==0.1.0

Setup

Use an environment variable instead of hardcoding API keys:

export OPENSEND_API_KEY="os_your_api_key"

For self-hosted OpenSend, point the SDK at your deployment origin. The default hosted origin is https://opensend.namuh.co.

export OPENSEND_BASE_URL="http://localhost:3015"

Send an email

The module-level surface keeps familiar Python email SDK ergonomics:

import os
import opensend

opensend.api_key = os.environ["OPENSEND_API_KEY"]
opensend.base_url = os.environ.get("OPENSEND_BASE_URL", opensend.DEFAULT_BASE_URL)

params: opensend.Emails.SendParams = {
    "from": "[e-mail]",
    "to": "[e-mail]",
    "subject": "Hello from OpenSend",
    "html": "<h1>It works!</h1>",
}

email = opensend.Emails.send(params)
print(email["id"])

Python reserves from as a keyword argument name, but dictionary keys can still use the OpenSend JSON field name. If you prefer constructing dictionaries with Python identifiers, the SDK also accepts from_ or from_email and sends that value as JSON from.

params: opensend.SendParams = {
    "from_": "[e-mail]",
    "to": ["[e-mail]"],
    "subject": "Hello from OpenSend",
    "text": "It works!",
}

Batch send

result = opensend.Emails.send_batch([
    {
        "from": "[e-mail]",
        "to": "[e-mail]",
        "subject": "Hi A",
        "html": "<p>A</p>",
    },
    {
        "from": "[e-mail]",
        "to": "[e-mail]",
        "subject": "Hi B",
        "html": "<p>B</p>",
    },
])

print(result["data"])

Instance client

import os
from opensend import DEFAULT_BASE_URL, OpenSend

client = OpenSend(
    os.environ["OPENSEND_API_KEY"],
    base_url=os.environ.get("OPENSEND_BASE_URL", DEFAULT_BASE_URL),
)

email = client.emails.send({
    "from": "[e-mail]",
    "to": "[e-mail]",
    "subject": "Hello from OpenSend",
    "html": "<h1>It works!</h1>",
})

Resend is also exported as an alias class for migration-oriented code:

from opensend import Resend

client = Resend(os.environ["OPENSEND_API_KEY"], base_url="http://localhost:3015")

Errors

Non-2xx API responses raise opensend.OpenSendError (also exported as opensend.ApiError). The exception keeps OpenSend's public error envelope fields when present.

try:
    opensend.Emails.send(params)
except opensend.OpenSendError as error:
    print(error.status_code, error.code, error.message, error.details)

Supported first slice

• opensend.Emails.send(params) → POST /emails
• opensend.Emails.send_batch(params) → POST /emails/batch
• Bearer API key auth
• Configurable base URL
• Optional idempotency_key= request header
• Typed request/response structures for transactional email sends

This first package intentionally does not implement every OpenSend API resource yet.

Tests

python -m unittest discover packages/python-sdk/tests