Skip to content
SendGrid's smtpapi library in Python
Python Dockerfile Shell
Branch: master
Clone or download
Latest commit 21239b1 Oct 31, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update contribution to use Gitflow workflow Oct 21, 2018
examples
smtpapi PEP-8 fix Oct 20, 2018
static/img add first-timers.md with guide for newcomers Oct 12, 2018
test Update test_project.py Oct 20, 2018
.codeclimate.yml updated from example here https://github.com/codeclimate/python-test-… Nov 15, 2017
.dockerignore
.env_sample Add .env_sample Oct 27, 2017
.gitignore fixed Travis, converted README and version as file Oct 9, 2018
.travis.yml fixed Travis, converted README and version as file Oct 9, 2018
CHANGELOG.md Version bump 0.3.1 Oct 1, 2015
CODE_OF_CONDUCT.md Created code of conduct Oct 10, 2017
CONTRIBUTING.md Update contribution to use Gitflow workflow Oct 21, 2018
Dockerfile
FIRST-TIMERS.md add first-timers.md with guide for newcomers Oct 12, 2018
LICENSE.txt Update LICENSE.txt Oct 1, 2018
MANIFEST.in fixed Travis, converted README and version as file Oct 9, 2018
README.rst fixed Travis, converted README and version as file Oct 9, 2018
TROUBLESHOOTING.md Demonstrate how to review the request body for troubleshooting Oct 21, 2017
USAGE.md Update USAGE.md Oct 29, 2017
VERSION.txt fixed Travis, converted README and version as file Oct 9, 2018
changes.py Changing PR attribution style as requested Oct 24, 2018
docker-compose.yml
run.sh Add docker files and update README Oct 27, 2017
setup.py

README.rst

SendGrid Logo

Travis Badge Email Notifications Badge Twitter Follow Codecov branch Python Versions PyPI Version GitHub contributors MIT Licensed

This module helps build SendGrid's SMTP API headers.

Learn more about the SMTP API at SendGrid documentation.

Announcements

All updates to this module is documented in our CHANGELOG.

Table of Contents

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@email.com')
print(header.json_string())

Usage

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:

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)

You can’t perform that action at this time.