Merge pull request #194 from sendgrid/mail-send-docs-update

README documentation improvements

Author: thinkingserious

README.md

@@ -1,27 +1,14 @@
 [![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-python.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-python)
 
-**This library allows you to quickly and easily use the SendGrid Web API via Python.**
+**This library allows you to quickly and easily use the SendGrid Web API v3 via Python.**
 
-# Announcements
-
-**BREAKING CHANGE as of 2016.06.14**
-
-Version `3.X.X` is a breaking change for the entire library.
-
-Version 3.X.X brings you full support for all Web API v3 endpoints. We
-have the following resources to get you started quickly:
+Version 3.X.X of this library provides full support for all SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
 
--   [SendGrid
-    Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html)
--   [Usage
-    Documentation](https://github.com/sendgrid/sendgrid-python/tree/master/USAGE.md)
--   [Example
-    Code](https://github.com/sendgrid/sendgrid-python/tree/master/examples)
--   [Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
+This library represents the beginning of a new path for SendGrid. We want this library to be community driven and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-python/issues) and [pull requests](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
 
-Thank you for your continued support!
+Please browse the rest of this README for further detail.
 
-All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-python/blob/master/CHANGELOG.md).
+We appreciate your continued support, thank you!
 
 # Installation
 
@@ -32,7 +19,7 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/
 
 ## Setup Environment Variables
 
-Update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys).
+Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example:
 
 ```bash
 echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
@@ -60,31 +47,85 @@ easy_install sendgrid
 
 ## Hello Email
 
+The following is the minimum needed code to send an email with the [/mail/send Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) ([here](https://github.com/sendgrid/sendgrid-python/blob/master/examples/helpers/mail/mail_example.py#L20) is a full example):
+
+### With Mail Helper Class
+
 ```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]")
-subject = "Hello World from the SendGrid Python Library"
+subject = "Hello World from the SendGrid Python Library!"
 to_email = Email("[email protected]")
-content = Content("text/plain", "some text here")
+content = Content("text/plain", "Hello, Email!")
 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)
 ```
 
-## General v3 Web API Usage
+The `Mail` constructor creates a [personalization object](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html) 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 to it.
+
+### Without Mail Helper Class
+
+The following is the minimum needed code to send an email without the /mail/send Helper ([here](https://github.com/sendgrid/sendgrid-python/blob/master/examples/mail/mail.py#L27) is a full example):
+
+```python
+import sendgrid
+import os
+
+data = {
+  "personalizations": [
+    {
+      "to": [
+        {
+          "email": "[email protected]"
+        }
+      ],
+      "subject": "Hello World from the SendGrid Python Library!"
+    }
+  ],
+  "from": {
+    "email": "[email protected]"
+  },
+  "content": [
+    {
+      "type": "text/plain",
+      "value": "Hello, Email!"
+    }
+  ]
+}
+response = sg.client.mail.send.post(request_body=data)
+print(response.status_code)
+print(response.body)
+print(response.headers)
+```
+
+## General v3 Web API Usage (With Fluent Interface)
+
+```python
+import sendgrid
+import os
+
+sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
+response = sg.client.suppression.bounces.get()
+print(response.status_code)
+print(response.body)
+print(response.headers)
+```
+
+## General v3 Web API Usage (Without Fluent Interface)
 
 ```python
 import sendgrid
 import os
 
 sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
-response = sg.client.api_keys.get()
+response = sg.client._("suppression/bounces").get()
 print(response.status_code)
 print(response.body)
 print(response.headers)
@@ -93,17 +134,22 @@ print(response.headers)
 # Usage
 
 - [SendGrid Documentation](https://sendgrid.com/docs/API_Reference/index.html)
-- [Usage Documentation](https://github.com/sendgrid/sendgrid-python/tree/master/USAGE.md)
+- [Library Usage Documentation](https://github.com/sendgrid/sendgrid-python/tree/master/USAGE.md)
 - [Example Code](https://github.com/sendgrid/sendgrid-python/tree/master/examples)
+- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
 - [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) - build a request object payload for a v3 /mail/send API call.
 
-## Roadmap
+# Announcements
+
+All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-python/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-python/releases).
+
+# Roadmap
 
-If you are intersted in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/sendgrid-python/milestones). We would love to hear your feedback.
+If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/sendgrid/sendgrid-python/issues) and [pull requests](https://github.com/sendgrid/sendgrid-python/pulls). We would love to hear your feedback.
 
-## How to Contribute
+# How to Contribute
 
-We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md) guide for details.
+We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md) guide for details.
 
 Quick links: