swecc-email-sender 1.0.5

A production-ready email automation library using SendGrid

SWECC Email Sender

An email automation library using SendGrid API. Supports both single and batch email sending with Markdown formatting and template substitution.

Features

• Single and batch email sending
• Markdown to HTML conversion with styling
• Template substitution support
• CSV and JSON data source support
• Preview and validation modes

Installation

pip install swecc-email-sender

Quick Start

Single Email

from swecc_email_sender import EmailSender

sender = EmailSender()  # uses SENDGRID_API_KEY environment variable
success = sender.send_email(
    to_email="[e-mail]",
    subject="Hello!",
    content="This is a test email",
    from_email="[e-mail]"
)

Markdown Email

success = sender.send_email(
    to_email="[e-mail]",
    subject="Hello!",
    content="# Hello World\n\nThis is a **markdown** email",
    from_email="[e-mail]",
    is_markdown=True
)

Template Email

template = """
Hello {name}!

Your order #{order_id} has been shipped to:
{address}

Thank you for your business!
"""

success = sender.send_email(
    to_email="[e-mail]",
    subject="Order #{order_id} Shipped",
    content=template,
    from_email="[e-mail]",
    template_data={
        "name": "John Doe",
        "order_id": "12345",
        "address": "123 Main St, City, Country"
    }
)

Command Line Interface

The package includes a command-line interface for easy use:

# Single email
swecc-email-sender --from [e-mail] --to [e-mail] --subject "Hello" --content "Test email"

# Markdown email
swecc-email-sender --from [e-mail] --to [e-mail] --subject "Hello" --content "# Hello" --markdown

# Template with CSV data
swecc-email-sender --from [e-mail] --src recipients.csv --subject "Hello {name}" --template email.md

# Preview first email
swecc-email-sender --from [e-mail] --src data.json --subject "Hello" --template email.md --preview

# Validate templates
swecc-email-sender --from [e-mail] --src data.json --subject "Hello {name}" --template email.md --validate

Data File Formats

CSV Example (recipients.csv)

to_email,name,order_id,address
[e-mail],John Doe,12345,123 Main St
[e-mail],Jane Smith,12346,456 Oak Ave

JSON Example (data.json)

[
  {
    "to_email": "[e-mail]",
    "name": "John Doe",
    "order_id": "12345",
    "address": "123 Main St"
  },
  {
    "to_email": "[e-mail]",
    "name": "Jane Smith",
    "order_id": "12346",
    "address": "456 Oak Ave"
  }
]

Development

Setup

1. Clone the repository:

git clone https://github.com/swecc/swecc-email-sender.git
cd swecc-email-sender

2. Create a virtual environment and install dependencies:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e ".[dev]"

Running Tests

pytest

Code Style

The project uses:

• Black for code formatting
• isort for import sorting
• mypy for type checking
• flake8 for linting

To run all checks:

ruff --fix
isort .
mypy swecc_email_sender
flake8 swecc_email_sender

License

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