Send emails programmatically with a simple Python interface
Project description
Email Me Anything
A simple Python package for sending emails programmatically with various content, such as quotes, custom messages, or data from CSV files. It provides utilities for handling CSV files, email configuration, and sending templated emails via MailerSend.
Installation
Install the package from PyPI:
pip install email_me_anything
Configuration
The package uses environment variables for configuration. Most are optional, but if you intend to send emails, certain variables become mandatory.
Create a .env file in your project directory with the following variables as needed:
# Optional: Sender details
EMAIL_SENDER=Your Name
EMAIL_SENDER_ADDRESS=your-email@example.com
# Optional: Recipient details (can be set programmatically if needed)
EMAIL_RECIPIENT_0_NAME=Recipient Name
EMAIL_RECIPIENT_0_ADDRESS=recipient@example.com
# Mandatory if email sending is required; defaults to false (no emails sent)
PROD_MODE=true
MAILERSEND_API_KEY=your-mailersend-api-key
- PROD_MODE: Set to
trueto enable email sending. Iffalse(default), no emails are sent just created and saved indebug-email.html, and no other keys are required. - If
PROD_MODEistrue, you must configure your MailerSend API key as per themailersendlibrary documentation (e.g., viaMAILERSEND_API_KEYenvironment variable).
Usage
Import the helpers below and work with pathlib Paths whenever you load templates or CSV files.
Sending a Lucky Email
Send a random row from a CSV file by rendering it into an HTML template. You can override the default sender and recipient values or pass a variable_map that renames CSV columns for the template.
from pathlib import Path
from email_me_anything import send_lucky_email
csv_path = Path("quotes.csv")
template_path = Path("templates/quote.html")
send_lucky_email(
csv_path,
template_path,
subject="Daily Inspiration",
recipients=[{"email": "friend@example.com", "name": "Friend"}],
variable_map={"quote": "text", "author": "author"},
)
Sending a Custom Email
Use build_html_content (and build_context if you need to massage the data) to render a template and send it with send_email.
from pathlib import Path
from email_me_anything import build_context, build_html_content, send_email
template = Path("templates/notification.html")
data = {"status": "Completed", "details": "System update succeeded."}
context = build_context(data)
html_content = build_html_content(template, context)
sender = {"email": "alerts@example.com", "name": "Alert Bot"}
recipients = [{"email": "ops@example.com", "name": "Ops Team"}]
send_email(sender, recipients, "System Alert", html_content)
variable_map lets you rename keys from data before rendering the template.
Working with CSV Files
read_csv returns the raw rows from a file, while select_random_row returns a dict keyed by the header row (or col0, col1, etc. when headers are missing).
from pathlib import Path
from email_me_anything import read_csv, select_random_row
csv_path = Path("quotes.csv")
rows = read_csv(csv_path)
if rows:
sample = select_random_row(csv_path)
print(sample)
select_random_row yields False when the file cannot be read and None when there are no rows beyond the header.
Examples
Example 1: Daily Quote Email
import schedule
from pathlib import Path
from email_me_anything import send_lucky_email
csv_path = Path("quotes.csv")
template_path = Path("templates/quote.html")
def send_daily_quote():
send_lucky_email(csv_path, template_path, subject="Quote of the Day")
# Schedule to run daily at 8 AM
schedule.every().day.at("08:00").do(send_daily_quote)
Example 2: Custom Notification Email
from pathlib import Path
from email_me_anything import build_context, build_html_content, send_email
template_path = Path("templates/notification.html")
data = {"title": "Alert", "message": "System update completed successfully."}
context = build_context(data, variable_map={"title": "title", "message": "message"})
html_content = build_html_content(template_path, context)
sender = {"email": "alerts@example.com", "name": "Alert System"}
recipients = [{"email": "team@example.com", "name": "Team"}]
send_email(sender, recipients, "System Alert", html_content)
Example 3: Bulk Email from CSV
from pathlib import Path
from email_me_anything import read_csv, build_html_content, send_email
template_path = Path("templates/bulk-welcome.html")
csv_path = Path("recipients.csv")
rows = read_csv(csv_path)
if not rows or len(rows) < 2:
raise SystemExit("No recipient data")
headers = rows[0]
sender = {"email": "hello@example.com", "name": "Hello Team"}
for row in rows[1:]:
data = dict(zip(headers, row))
recipient = {"email": data["email"], "name": data["name"]}
html = build_html_content(template_path, data)
send_email(sender, [recipient], f"Welcome {data['name']}", html)
Testing
The package includes comprehensive test coverage using pytest. Tests verify:
- Configuration Management: Parsing of environment variables with proper defaults
- CSV Operations: Reading CSV files, handling missing/malformed data, random row selection with deterministic and probabilistic tests
- Email Building: HTML template rendering, variable mapping, Unicode support, error handling
- Email Sending: Integration with MailerSend API, recipient handling, production vs. debug modes
- Complete Workflows: End-to-end email sending through
send_lucky_emailwith variable maps and default values
Running Tests
Install development dependencies and run pytest:
pip install pytest
pytest tests/ -v
Current test suite includes 42 tests covering:
- 8 configuration tests (env variable parsing, defaults)
- 13 CSV utility tests (reading, parsing, randomization)
- 11 email utility tests (context building, HTML rendering, sending)
- 10 integration tests (complete workflows, mode switching)
License
Apache License 2.0
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file email_me_anything-0.1.1.tar.gz.
File metadata
- Download URL: email_me_anything-0.1.1.tar.gz
- Upload date:
- Size: 11.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.14.0 Windows/11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0f8fbf79d87c74870191f49f892116772e8c909d3d17e0169e20f705178a77e
|
|
| MD5 |
64a17e41be4631b2221649b8749a5cb1
|
|
| BLAKE2b-256 |
5fcbf1a0635b36d50a48c634588f1f3888d28c21c289df6b9d72ce66138fbeef
|
File details
Details for the file email_me_anything-0.1.1-py3-none-any.whl.
File metadata
- Download URL: email_me_anything-0.1.1-py3-none-any.whl
- Upload date:
- Size: 12.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.14.0 Windows/11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a895b678641bc69f7258d89a34da52870416b8d968cf8aacce3db801273b3ac7
|
|
| MD5 |
cede5b58364ba47f5d21dd7e8051b174
|
|
| BLAKE2b-256 |
00583660fd4edec37028bd032de3f1e78d84ba4f0767421d00ef35fca4d7d00a
|