A modern, asynchronous SendGrid client built on top of httpx. This library provides a simple and efficient way to send emails using SendGrid's API with Python's async/await syntax.
- 🚀 Asynchronous API client for SendGrid
- 🔄 Connection pooling for better performance
- 📊 OpenTelemetry integration for monitoring
- 🔍 Detailed error tracking and tracing
- 🛠️ Customizable configuration
- 📝 Comprehensive documentation
Install the package using pip:
pip install sendgrid-asyncfrom async_sendgrid import SendgridAPI
from sendgrid.helpers.mail import Mail
# Initialize the client
sendgrid = SendgridAPI(api_key="YOUR_API_KEY")
# Create and send an email
email = Mail(
from_email="[email protected]",
to_emails="[email protected]",
subject="Hello World",
plain_text_content="Hello World!",
)
response = await sendgrid.send(email)Optimize performance with connection pooling:
from async_sendgrid import SendgridAPI
from async_sendgrid.pool import ConnectionPool
pool = ConnectionPool(
max_connections=20,
max_keepalive_connections=10,
keepalive_expiry=10.0,
)
sendgrid = SendgridAPI(
api_key="YOUR_API_KEY",
pool=pool,
)Send emails on behalf of subusers:
sendgrid = SendgridAPI(
api_key="YOUR_API_KEY",
on_behalf_of="John Smith",
)Use custom API endpoints:
sendgrid = SendgridAPI(
api_key="YOUR_API_KEY",
endpoint="https://custom.endpoint.com/v3/mail/send",
)Monitor and trace your SendGrid operations with OpenTelemetry:
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
# Configure OpenTelemetry
tracer_provider = TracerProvider()
trace.set_tracer_provider(tracer_provider)
# Add your exporter
otlp_exporter = OTLPSpanExporter()
span_processor = BatchSpanProcessor(otlp_exporter)
tracer_provider.add_span_processor(span_processor)The library automatically tracks:
- Status codes
- Response sizes
- URLs
- Methods
- Number of recipients
- Attachment presence
- Email content type
Control telemetry behavior with environment variables:
# Disable telemetry
SENDGRID_TELEMETRY_IS_ENABLED=false
# Custom span name
SENDGRID_TELEMETRY_SPAN_NAME=custom.span.nameRobust error handling for API operations:
try:
response = await sendgrid.send(email)
except Exception as e:
# Handle the error
print(f"Error sending email: {e}")# Clone the repository
git clone https://github.com/yourusername/async-sendgrid.git
cd async-sendgrid
# Install development dependencies
pip install -e ".[test]"# Run all tests
pytest
# Run with coverage
pytest --cov=async_sendgridContributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.