Merge branch 'master' into client_cleanup

Author: thinkingserious

.gitignore

@@ -21,4 +21,5 @@ coverage.xml
 htmlcov
 temp*.py
 sendgrid.env
+.vscode
 

.travis.yml

@@ -7,6 +7,9 @@ python:
 - '3.4'
 - '3.5'
 - '3.6'
+env:
+  global:
+    - CC_TEST_REPORTER_ID=$TRAVIS_CODE_CLIMATE_TOKEN
 install:
 - if [[ $TRAVIS_PYTHON_VERSION == 2.6* ]]; then pip install unittest2; fi
 - python setup.py install
@@ -21,12 +24,16 @@ addons:
   apt_packages:
     - pandoc
 before_script:
-- . ./test/prism.sh
-- prism version
+- "./test/prism.sh &"
+- sleep 20
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- ./cc-test-reporter before-build
 script:
 - if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then coverage run -m unittest2 discover; else coverage run -m unittest discover; fi
 after_script:
 - codecov
+- ./cc-test-reporter after-build --exit-code $?
 before_deploy:
 - python ./register.py
 deploy:
@@ -46,7 +53,7 @@ notifications:
     template:
     - '<a href="https://travis-ci.org/%{repository}/builds/%{build_id}">%{repository}
       Build %{build_number}</a> on branch <i>%{branch}</i> by %{author}: <strong>%{message}</strong>
-      <a href="https://github.com/sendgrid/%{repository}/commits/%{commit}">View on
+      <a href="https://github.com/%{repository}/commits/%{commit}">View on
       GitHub</a>'
     format: html
     notify: false

CONTRIBUTING.md

@@ -12,7 +12,7 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
 - [Code Reviews](#code-reviews)
 
 <a name="roadmap"></a>
-We use [Milestones](https://github.com/sendgrid/sendgrid-python/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged.
+We use [Milestones](https://github.com/sendgrid/sendgrid-python/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community reviews, comments, suggestions and additional PRs are welcomed and encouraged.
 
 <a name="cla"></a>
 ## CLAs and CCLAs
@@ -60,11 +60,13 @@ In order to make the process easier, we've included a [sample bug report templat
 We welcome direct contributions to the sendgrid-python code base. Thank you!
 
 ### Development Environment ###
-
-#### Using Docker ####
+#### There are two ways to get set up: ####
+#### 1. Using Docker ####
+This is usually the easiest and fastest way to get set up. 
 You can use our Docker image to avoid setting up the development environment yourself.  See [USAGE.md](https://github.com/sendgrid/sendgrid-python/blob/master/docker/USAGE.md).
 
-#### Install and Run Locally ####
+#### - OR - ####
+#### 2. Install and Run Locally ####
 
 ##### Prerequisites #####
 
@@ -78,7 +80,7 @@ git clone https://github.com/sendgrid/sendgrid-python.git
 cd sendgrid-python
 ```
 
-## Environment Variables
+### Environment Variables
 
 First, get your free SendGrid account [here](https://sendgrid.com/free?source=sendgrid-python).
 
@@ -114,7 +116,7 @@ The Web API v3 client is `sendgrid.py`, the other files are legacy code for our
 <a name="testing"></a>
 ## Testing
 
-All PRs require passing tests before the PR will be reviewed.
+The PR must pass all the tests before it is reviewed.
 
 All test files are in the [`test`](https://github.com/sendgrid/sendgrid-python/test) directory.
 
@@ -130,7 +132,7 @@ For Python 2.7.* and up:
 
 ### Testing Multiple Versions of Python
 
-All PRs require passing tests before the PR will be reviewed.
+The PR must pass all the tests before it is reviewed.
 
 #### Prerequisites: ####
 
@@ -140,7 +142,7 @@ The above local "Initial setup" is complete
 * [tox](https://pypi.python.org/pypi/tox)
 * [prism](https://github.com/stoplightio/prism) v0.6 - It should be available in your PATH, but unittest script
 will try to install it locally if not found. Apart from PATH env variable it will check in `~/bin` and `/usr/local/bin`.
-You can install by yourself it in user dir by calling `source test/prism.sh`.
+You can install it by yourself in user dir by calling `source test/prism.sh`.
 
 #### Initial setup: ####
 
@@ -151,8 +153,13 @@ pyenv install 2.6.9
 pyenv install 2.7.11
 pyenv install 3.4.3
 pyenv install 3.5.0
+```
+Make sure to change the current working directory to your local version of the repo before running the following command:
+```
 python setup.py install
-pyenv local 3.5.0 3.4.3 2.7.8 2.6.9
+```
+```
+pyenv local 3.5.0 3.4.3 2.7.11 2.6.9
 pyenv rehash
 ```
 

README.md

@@ -8,7 +8,7 @@
 [![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
 [![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/sendgrid-python.svg)](https://github.com/sendgrid/sendgrid-python/graphs/contributors)
 
-**NEW:** 
+**NEW:**
 
 * Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/python) for releases and breaking changes.
 * Quickly get started with [Docker](https://github.com/sendgrid/sendgrid-python/tree/master/docker).
@@ -55,7 +55,7 @@ echo "sendgrid.env" >> .gitignore
 source ./sendgrid.env
 ```
 
-Sendgrid also supports local enviroment file `.env`. Copy or rename `.env_sample` into `.env` and update [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys) with your key.
+Sendgrid also supports local environment file `.env`. Copy or rename `.env_sample` into `.env` and update [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys) with your key.
 
 ## Install Package
 
@@ -175,7 +175,7 @@ Please see [our helper](https://github.com/sendgrid/sendgrid-python/tree/master/
 <a name="use-cases"></a>
 # Use Cases
 
-[Examples of common API use cases](https://github.com/sendgrid/sendgrid-python/blob/master/USE_CASES.md), such as how to send an email with a transactional template.
+[Examples of common API use cases](https://github.com/sendgrid/sendgrid-python/blob/master/use_cases/README.md), such as how to send an email with a transactional template.
 
 <a name="announcements"></a>
 # Announcements

TROUBLESHOOTING.md

@@ -111,4 +111,4 @@ print mail.get()
 <a name="error-handling"></a>
 # Error Handling
 
-Please review [our use_cases](https://github.com/sendgrid/sendgrid-python/USE_CASES.md) for examples of error handling.
+Please review [our use_cases](https://github.com/sendgrid/sendgrid-python/use_cases/README.md) for examples of error handling.

USAGE.md

@@ -434,7 +434,7 @@ print response.headers
 
 **This endpoint allows you to create a new suppression group.**
 
-Suppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
+Suppression groups, or unsubscribe groups, are specific types or categories of emails that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
 
 The **name** and **description** of the unsubscribe group will be visible by recipients when they are managing their subscriptions.
 
@@ -478,7 +478,7 @@ print response.headers
 
 **This endpoint allows you to update or change a suppression group.**
 
-Suppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
+Suppression groups, or unsubscribe groups, are specific types or categories of emails that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
 
 The **name** and **description** of the unsubscribe group will be visible by recipients when they are managing their subscriptions.
 
@@ -503,7 +503,7 @@ print response.headers
 
 **This endpoint allows you to retrieve a single suppression group.**
 
-Suppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
+Suppression groups, or unsubscribe groups, are specific types or categories of emails that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
 
 The **name** and **description** of the unsubscribe group will be visible by recipients when they are managing their subscriptions.
 
@@ -525,7 +525,7 @@ print response.headers
 
 You can only delete groups that have not been attached to sent mail in the last 60 days. If a recipient uses the "one-click unsubscribe" option on an email associated with a deleted group, that recipient will be added to the global suppression list.
 
-Suppression groups, or unsubscribe groups, are specific types or categories of email that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
+Suppression groups, or unsubscribe groups, are specific types or categories of emails that you would like your recipients to be able to unsubscribe from. For example: Daily Newsletters, Invoices, System Alerts.
 
 The **name** and **description** of the unsubscribe group will be visible by recipients when they are managing their subscriptions.