Updated documentation

Author: thinkingserious

.github/PULL_REQUEST_TEMPLATE

@@ -1,13 +1,13 @@
 <!--
-We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines given above, then fill out the blanks below.
+We appreciate the effort for this pull request, but before that, please make sure you read the [contribution guidelines](https://github.com/sendgrid/sendgrid-python/blob/v4/CONTRIBUTING.md), and then fill out the blanks below.
 
 
 Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged!
 e.g. 
 Fixes #1
 Closes #2
 -->
-# Fixes # 
+# Fixes #X
 
 ### Checklist
 - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
@@ -19,6 +19,5 @@ Closes #2
 
 ### Short description of what this PR does:
 - 
-- 
 
-If you have questions, please send an email to [SendGrid](mailto:[email protected]), or file a GitHub Issue in this repository.
+If you have questions, please send an email to [Twilio SendGrid](mailto:[email protected]), or file a GitHub Issue in this repository.

.gitignore

@@ -22,3 +22,5 @@ htmlcov
 temp.py
 .vscode
 live_test.py
+__pycache__
+example.pdf

README.rst

@@ -104,20 +104,23 @@ With Mail Helper Class
 
 .. code:: python
 
-    import sendgrid
     import os
-    from sendgrid.helpers.mail import *
-
-    sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
-    from_email = Email("[email protected]")
-    to_email = Email("[email protected]")
-    subject = "Sending with SendGrid is Fun"
-    content = Content("text/plain", "and easy to do anywhere, even with Python")
-    mail = Mail(from_email, subject, to_email, content)
-    response = sg.client.mail.send.post(request_body=mail.get())
-    print(response.status_code)
-    print(response.body)
-    print(response.headers)
+    from sendgrid import SendGridAPIClient
+    from sendgrid.helpers.mail import Mail
+
+    message = Mail(
+        from_email='[email protected]',
+        to_emails='[email protected]',
+        subject='Sending with SendGrid is Fun',
+        html_content='<strong>and easy to do anywhere, even with Python</strong>')
+    try:
+        sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
+        response = sg.send(message)
+        print(response.status_code)
+        print(response.body)
+        print(response.headers)
+    except Exception as e:
+        print(e.message)
 
 The ``Mail`` constructor creates a `personalization object`_ for you.
 `Here <https://github.com/sendgrid/sendgrid-python/blob/master/examples/helpers/mail/mail_example.py#L16>`__ is an example of how to add it.
@@ -130,45 +133,48 @@ The following is the minimum needed code to send an email without the /mail/send
 
 .. code:: python
 
-    import sendgrid
     import os
+    from sendgrid import SendGridAPIClient
 
-    sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
-    data = {
-      "personalizations": [
-        {
-          "to": [
+    message = {
+        'personalizations': [
+            {
+                'to': [
+                    {
+                        'email': '[email protected]'
+                    }
+                ],
+                'subject': 'Sending with SendGrid is Fun'
+            }
+        ],
+        'from': {
+            'email': '[email protected]'
+        },
+        'content': [
             {
-              "email": "[email protected]"
+                'type': 'text/plain',
+                'value': 'and easy to do anywhere, even with Python'
             }
-          ],
-          "subject": "Sending with SendGrid is Fun"
-        }
-      ],
-      "from": {
-        "email": "[email protected]"
-      },
-      "content": [
-        {
-          "type": "text/plain",
-          "value": "and easy to do anywhere, even with Python"
-        }
-      ]
+        ]
     }
-    response = sg.client.mail.send.post(request_body=data)
-    print(response.status_code)
-    print(response.body)
-    print(response.headers)
+    try:
+        sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
+        response = sg.send(message)
+        print(response.status_code)
+        print(response.body)
+        print(response.headers)
+    except Exception as e:
+        print(e.message)
 
 General v3 Web API Usage (With `Fluent Interface`_)
 ---------------------------------------------------
 
 .. code:: python
 
-    import sendgrid
     import os
+    from sendgrid import SendGridAPIClient
 
-    sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
+    sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
     response = sg.client.suppression.bounces.get()
     print(response.status_code)
     print(response.body)
@@ -179,11 +185,11 @@ General v3 Web API Usage (Without `Fluent Interface`_)
 
 .. code:: python
 
-    import sendgrid
     import os
+    from sendgrid import SendGridAPIClient
 
-    sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
-    response = sg.client._("suppression/bounces").get()
+    sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
+    response = sg.client._('suppression/bounces').get()
     print(response.status_code)
     print(response.body)
     print(response.headers)

TROUBLESHOOTING.md

@@ -38,7 +38,7 @@ To read the error message returned by SendGrid's API in Python 2.X:
 import urllib2
 
 try:
-  response = sg.client.mail.send.post(request_body=mail.get())
+  response = sendgrid_client.send(request_body=mail.get())
 except urllib2.HTTPError as e:
     print(e.read())
 ```
@@ -48,7 +48,7 @@ To read the error message returned by SendGrid's API in Python 3.X:
 ```python
 import urllib
 try:
-  response = sg.client.mail.send.post(request_body=mail.get())
+  response = sendgrid_client.send(request_body=mail.get())
 except urllib.error.HTTPError as e:
     print(e.read())
 ```

USAGE.md

@@ -3,11 +3,11 @@ This documentation is based on our [OAI specification](https://github.com/sendgr
 # INITIALIZATION
 
 ```python
-import sendgrid
+from sendgrid import SendGridAPIClient
 import os
 
 
-sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
+sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
 ```
 
 # Table of Contents

docker-test/README.md

@@ -1,4 +1,4 @@
-Use Docker to easily try out or contribute to the sendgrid-python library. 
+Use Docker to easily test the sendgrid-python library. 
 
 This Docker image contains:
  - Python 3.6

docker/README.md

@@ -20,6 +20,7 @@
  - `v3.2.2`
  - `v3.2.1`
  - `v3.2.0`
+
 # Quick reference
  - **Where to get help:**
    [Contact SendGrid Support](https://support.sendgrid.com/hc/en-us)