Merge branch 'master' of https://github.com/sendgrid/sendgrid-python

Author: thinkingserious

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 #####
 
@@ -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
 ```
 

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.
 

examples/accesssettings/accesssettings.py

@@ -20,17 +20,17 @@
 # POST /access_settings/whitelist #
 
 data = {
-  "ips": [
-    {
-      "ip": "192.168.1.1"
-    }, 
-    {
-      "ip": "192.*.*.*"
-    }, 
-    {
-      "ip": "192.168.1.3/32"
-    }
-  ]
+    "ips": [
+        {
+            "ip": "192.168.1.1"
+        },
+        {
+            "ip": "192.*.*.*"
+        },
+        {
+            "ip": "192.168.1.3/32"
+        }
+    ]
 }
 response = sg.client.access_settings.whitelist.post(request_body=data)
 print(response.status_code)
@@ -51,11 +51,11 @@
 # DELETE /access_settings/whitelist #
 
 data = {
-  "ids": [
-    1, 
-    2, 
-    3
-  ]
+    "ids": [
+        1,
+        2,
+        3
+    ]
 }
 response = sg.client.access_settings.whitelist.delete(request_body=data)
 print(response.status_code)
@@ -81,4 +81,3 @@
 print(response.status_code)
 print(response.body)
 print(response.headers)
-

examples/alerts/alerts.py

@@ -10,9 +10,9 @@
 # POST /alerts #
 
 data = {
-  "email_to": "example@example.com", 
-  "frequency": "daily", 
-  "type": "stats_notification"
+    "email_to": "example@example.com",
+    "frequency": "daily",
+    "type": "stats_notification"
 }
 response = sg.client.alerts.post(request_body=data)
 print(response.status_code)
@@ -33,7 +33,7 @@
 # PATCH /alerts/{alert_id} #
 
 data = {
-  "email_to": "example@example.com"
+    "email_to": "example@example.com"
 }
 alert_id = "test_url_param"
 response = sg.client.alerts._(alert_id).patch(request_body=data)
@@ -60,4 +60,3 @@
 print(response.status_code)
 print(response.body)
 print(response.headers)
-

examples/apikeys/apikeys.py

@@ -10,13 +10,13 @@
 # POST /api_keys #
 
 data = {
-  "name": "My API Key", 
-  "sample": "data", 
-  "scopes": [
-    "mail.send", 
-    "alerts.create", 
-    "alerts.read"
-  ]
+    "name": "My API Key",
+    "sample": "data",
+    "scopes": [
+        "mail.send",
+        "alerts.create",
+        "alerts.read"
+    ]
 }
 response = sg.client.api_keys.post(request_body=data)
 print(response.status_code)
@@ -38,11 +38,11 @@
 # PUT /api_keys/{api_key_id} #
 
 data = {
-  "name": "A New Hope", 
-  "scopes": [
-    "user.profile.read", 
-    "user.profile.update"
-  ]
+    "name": "A New Hope",
+    "scopes": [
+        "user.profile.read",
+        "user.profile.update"
+    ]
 }
 api_key_id = "test_url_param"
 response = sg.client.api_keys._(api_key_id).put(request_body=data)
@@ -55,7 +55,7 @@
 # PATCH /api_keys/{api_key_id} #
 
 data = {
-  "name": "A New Hope"
+    "name": "A New Hope"
 }
 api_key_id = "test_url_param"
 response = sg.client.api_keys._(api_key_id).patch(request_body=data)
@@ -82,4 +82,3 @@
 print(response.status_code)
 print(response.body)
 print(response.headers)
-

examples/asm/asm.py

@@ -10,9 +10,9 @@
 # POST /asm/groups #
 
 data = {
-  "description": "Suggestions for products our users might like.", 
-  "is_default": True, 
-  "name": "Product Suggestions"
+    "description": "Suggestions for products our users might like.",
+    "is_default": True,
+    "name": "Product Suggestions"
 }
 response = sg.client.asm.groups.post(request_body=data)
 print(response.status_code)
@@ -34,9 +34,9 @@
 # PATCH /asm/groups/{group_id} #
 
 data = {
-  "description": "Suggestions for items our users might like.", 
-  "id": 103, 
-  "name": "Item Suggestions"
+    "description": "Suggestions for items our users might like.",
+    "id": 103,
+    "name": "Item Suggestions"
 }
 group_id = "test_url_param"
 response = sg.client.asm.groups._(group_id).patch(request_body=data)
@@ -69,13 +69,14 @@
 # POST /asm/groups/{group_id}/suppressions #
 
 data = {
-  "recipient_emails": [
-    "test1@example.com", 
-    "test2@example.com"
-  ]
+    "recipient_emails": [
+        "test1@example.com",
+        "test2@example.com"
+    ]
 }
 group_id = "test_url_param"
-response = sg.client.asm.groups._(group_id).suppressions.post(request_body=data)
+response = sg.client.asm.groups._(
+    group_id).suppressions.post(request_body=data)
 print(response.status_code)
 print(response.body)
 print(response.headers)
@@ -95,14 +96,15 @@
 # POST /asm/groups/{group_id}/suppressions/search #
 
 data = {
-  "recipient_emails": [
-    "exists1@example.com", 
-    "exists2@example.com", 
-    "doesnotexists@example.com"
-  ]
+    "recipient_emails": [
+        "exists1@example.com",
+        "exists2@example.com",
+        "doesnotexists@example.com"
+    ]
 }
 group_id = "test_url_param"
-response = sg.client.asm.groups._(group_id).suppressions.search.post(request_body=data)
+response = sg.client.asm.groups._(
+    group_id).suppressions.search.post(request_body=data)
 print(response.status_code)
 print(response.body)
 print(response.headers)
@@ -132,10 +134,10 @@
 # POST /asm/suppressions/global #
 
 data = {
-  "recipient_emails": [
-    "test1@example.com", 
-    "test2@example.com"
-  ]
+    "recipient_emails": [
+        "test1@example.com",
+        "test2@example.com"
+    ]
 }
 response = sg.client.asm.suppressions._("global").post(request_body=data)
 print(response.status_code)
@@ -171,4 +173,3 @@
 print(response.status_code)
 print(response.body)
 print(response.headers)
-

examples/browsers/browsers.py

@@ -9,9 +9,13 @@
 # Retrieve email statistics by browser.  #
 # GET /browsers/stats #
 
-params = {'end_date': '2016-04-01', 'aggregated_by': 'day', 'browsers': 'test_string', 'limit': 'test_string', 'offset': 'test_string', 'start_date': '2016-01-01'}
+params = {'end_date': '2016-04-01',
+          'aggregated_by': 'day',
+          'browsers': 'test_string',
+          'limit': 'test_string',
+          'offset': 'test_string',
+          'start_date': '2016-01-01'}
 response = sg.client.browsers.stats.get(query_params=params)
 print(response.status_code)
 print(response.body)
 print(response.headers)
-