Merge branch 'master' into mail-helpers-refactoring

Author: denis90

.gitignore

@@ -14,6 +14,5 @@ venv/
 .python-version
 .tox/
 profile*
-register.py
 README.txt
 temp*.py

.travis.yml

@@ -6,6 +6,7 @@ python:
 - '2.7'
 - '3.4'
 - '3.5'
+- '3.6'
 install:
 - python setup.py install
 - pip install pyyaml

CHANGELOG.md

@@ -1,6 +1,31 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [3.6.5] - 2017-03-30 ##
+### Updated
+- Pull #300 [Exclude test package](https://github.com/sendgrid/sendgrid-python/pull/250)
+- Big thanks to [Iryna Shcherbina](https://github.com/irushchyshyn) for the pull request!
+
+## [3.6.4] - 2017-03-29 ##
+### Updated
+- Pull #250 [Improve code quality](https://github.com/sendgrid/sendgrid-python/pull/250)
+- Big thanks to [Andrii Soldatenko](https://github.com/andriisoldatenko) for the pull request!
+
+## [3.6.3] - 2016-11-10 ##
+### Updated
+- Pull #243 [Update deprecated Heroku command](https://github.com/sendgrid/sendgrid-python/pull/243)
+- Big thanks to [Roberto Ortega](https://github.com/berto) for the pull request!
+
+## [3.6.2] - 2016-11-10 ##
+### Fixed
+- Pull #240 [Add six to requirements.txt](https://github.com/sendgrid/sendgrid-python/pull/246)
+- Big thanks to [Wataru Sato](https://github.com/awwa) for the pull request!
+
+## [3.6.1] - 2016-11-10 ##
+### Fixed
+- Pull #246 [Typo 'user' for 'usr'](https://github.com/sendgrid/sendgrid-python/pull/246)
+- Big thanks to [Mike Ralphson](https://github.com/MikeRalphson) for the pull request!
+
 ## [3.6.0] - 2016-10-11 ##
 ### Added
 - Pull #234 [Substitutions allow non-strings for values](https://github.com/sendgrid/sendgrid-python/pull/234)

CONTRIBUTING.md

@@ -64,7 +64,7 @@ We welcome direct contributions to the sendgrid-python code base. Thank you!
 
 ##### Prerequisites #####
 
-- Python 2.6 through 3.5
+- Python 2.6 through 3.6
 - [python_http_client](https://github.com/sendgrid/python-http-client)
 
 ##### Initial setup: #####

README.md

@@ -4,7 +4,7 @@ Please see our announcement regarding [breaking changes](https://github.com/send
 
 **This library allows you to quickly and easily use the SendGrid Web API v3 via Python.**
 
-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).
+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).
 
 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.
 
@@ -30,7 +30,7 @@ We appreciate your continued support, thank you!
 
 ## Prerequisites
 
-- Python version 2.6, 2.7, 3.4 or 3.5
+- Python version 2.6, 2.7, 3.4, 3.5 or 3.6
 - The SendGrid service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-python)
 
 ## Setup Environment Variables

TROUBLESHOOTING.md

@@ -2,7 +2,6 @@ If you have a non-library SendGrid issue, please contact our [support team](http
 
 If you can't find a solution below, please open an [issue](https://github.com/sendgrid/sendgrid-python/issues).
 
-
 ## Table of Contents
 
 * [Migrating from v2 to v3](#migrating)

USE_CASES.md

@@ -3,6 +3,7 @@ This documentation provides examples for specific use cases. Please [open an iss
 # Table of Contents
 
 * [Transactional Templates](#transactional_templates)
+* [Attachment](#attachment)
 
 <a name="transactional_templates"></a>
 # Transactional Templates
@@ -66,7 +67,7 @@ mail.set_template_id("13b8f94f-bcae-4ec6-b752-70d6cb59f932")
 try:
     response = sg.client.mail.send.post(request_body=mail.get())
 except urllib.HTTPError as e:
-    print e.read()
+    print (e.read())
     exit()
 print(response.status_code)
 print(response.body)
@@ -115,9 +116,56 @@ data = {
 try:
     response = sg.client.mail.send.post(request_body=data)
 except urllib.HTTPError as e:
-    print e.read()
+    print (e.read())
     exit()
 print(response.status_code)
 print(response.body)
 print(response.headers)
 ```
+
+<a name="attachment"></a>
+# Attachment
+
+```python
+import base64
+import sendgrid
+import os
+from sendgrid.helpers.mail import Email, Content, Mail, Attachment
+try:
+    # Python 3
+    import urllib.request as urllib
+except ImportError:
+    # Python 2
+    import urllib2 as urllib
+
+sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))
+from_email = Email("[email protected]")
+subject = "subject"
+to_email = Email("[email protected]")
+content = Content("text/html", "I'm a content example")
+
+file_path = "file_path.pdf"
+with open(file_path,'rb') as f:
+    data = f.read()
+    f.close()
+encoded = base64.b64encode(data).decode()
+
+attachment = Attachment()
+attachment.set_content(encoded)
+attachment.set_type("application/pdf")
+attachment.set_filename("test.pdf")
+attachment.set_disposition("attachment")
+attachment.set_content_id("Example Content ID")
+
+mail = Mail(from_email, subject, to_email, content)
+mail.add_attachment(attachment)
+try:
+    response = sg.client.mail.send.post(request_body=mail.get())
+except urllib.HTTPError as e:
+    print(e.read())
+    exit()
+
+print(response.status_code)
+print(response.body)
+print(response.headers)
+```

examples/helpers/mail/mail_example.py

@@ -121,6 +121,8 @@ def build_kitchen_sink():
     return mail.get()
 
 def send_hello_email():
+    # Assumes you set your environment variable:
+    # https://github.com/sendgrid/sendgrid-python/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key
     sg = SendGridAPIClient()
     data = build_hello_email()
     response = sg.client.mail.send.post(request_body=data)
@@ -129,6 +131,8 @@ def send_hello_email():
     print(response.body)
 
 def send_kitchen_sink():
+    # Assumes you set your environment variable:
+    # https://github.com/sendgrid/sendgrid-python/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key
     sg = SendGridAPIClient()
     data = build_kitchen_sink()
     response = sg.client.mail.send.post(request_body=data)

register.py

@@ -0,0 +1,7 @@
+import pypandoc
+import os
+
+output = pypandoc.convert('README.md', 'rst')
+f = open('README.txt','w+')
+f.write(output)
+f.close()

requirements.txt

@@ -1,3 +1,4 @@
 Flask==0.10.1
 PyYAML==3.11
-python-http-client==2.2.1
+python-http-client==2.2.1
+six==1.10.0