souri/smtpapi-python

It's Hacktoberfest!! SendGrid is giving out shirts if you make pull requests!

This module helps build SendGrid's SMTP API headers.

Learn more about the SMTP API at SendGrid's documentation.

Announcements

All updates to this module is documented in our CHANGELOG.

Table of Contents

• Installation
• Quick Start
• Usage
• Roadmap
• How to Contribute
• Local set up
• About
• License

Installation

Prerequisites

• Python version 2.6, 2.7, 3.4 or 3.5
• The SendGrid service, starting at the free level

Install Package

pip install smtpapi

Setup Environment Variables

Update the development environment with your SENDGRID_API_KEY, for example:

cp .env_sample .env

In .env set SENDGRID_API_KEY to your own API key.

You can add your environment variables to your environment by sourcing the file:

source .env

Quick Start

from smtpapi import SMTPAPIHeader
header = SMTPAPIHeader()
header.add_to('[email protected]')
print(header.json_string())

Usage

• SendGrid Docs
• Example Code

Roadmap

If you are interested in the future direction of this project, please take a look at our milestones. We would love to hear your feedback.

How to Contribute

We encourage contribution to our projects, please see our CONTRIBUTING guide for details.

Quick links:

• Feature Request
• Bug Reports
• Sign the CLA to Create a Pull Request
• Improvements to the Codebase

Local Setup of the project

The simplest local development workflow is by using docker.

Steps

1. Install Docker
2. Run docker-compose build (This builds the container)
3. Run docker-compose up (This runs tests by default)

About

smtpapi-python is guided and supported by the SendGrid Developer Experience Team.

smtpapi-python is maintained and funded by SendGrid, Inc. The names and logos for smtpapi-python are trademarks of SendGrid, Inc.

License

The MIT License (MIT)