Merge Conflicts

Author: thinkingserious

CHANGELOG.md

@@ -6,37 +6,37 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [3.1.0] - 2018-05-23
 ### Added
 - [Update register.py to use pypandoc](https://github.com/sendgrid/python-http-client/commit/6a3a63e2511b3df9c9ef23eebd5bcd80ad8821ae)
-- [PR #21](https://github.com/sendgrid/python-http-client/pull/21): Support timeout. Thanks [George Kussumoto](https://github.com/georgeyk)!
-- [PR #22](https://github.com/sendgrid/python-http-client/pull/22): Client can be pickled and unpickled. Thanks [Jussi Heikkilä](https://github.com/jussih)!
-- [PR #26](https://github.com/sendgrid/python-http-client/pull/26): Create CODE_OF_CONDUCT.md. Thanks [Fredrik Svensson](https://github.com/SvenssonWeb)!
-- [PR #30](https://github.com/sendgrid/python-http-client/pull/30): Create TROUBLESHOOTING.md. Thanks [Omer Ahmed Khan](https://github.com/OmerAhmedKhan)!
-- [PR #33](https://github.com/sendgrid/python-http-client/pull/33): Update README.md badges and license. Thanks [Alfred Gutierrez](https://github.com/alfg)!
-- [PR #34](https://github.com/sendgrid/python-http-client/pull/34): Update .md files for SEO. Thanks [Gustavo Siqueira](https://github.com/gugsrs)!
-- [PR #36](https://github.com/sendgrid/python-http-client/pull/36): Added more badges to README.md. Thanks [Shivam Agarwal](https://github.com/gr8shivam)!
-- [PR #41](https://github.com/sendgrid/python-http-client/pull/41): Added License link to README ToC. Thanks [Andrew Joshua Loria](https://github.com/ajloria)!
-- [PR #49](https://github.com/sendgrid/python-http-client/pull/49): Add USAGE.md. Thanks [Adelmo Junior](https://github.com/noblehelm)!
-- [PR #43](https://github.com/sendgrid/python-http-client/pull/43): Add PULL_REQUEST_TEMPLATE. Thanks [Aleksandr Sobolev](https://github.com/s0b0lev)!
-- [PR #50](https://github.com/sendgrid/python-http-client/pull/50): Add Docker files and update README. Thanks [Stanley Ndagi](https://github.com/NdagiStanley)!
-- [PR #69](https://github.com/sendgrid/python-http-client/pull/69): Simplify GitHub PR template. Thanks [Alex](https://github.com/pushkyn)!
-- [PR #61](https://github.com/sendgrid/python-http-client/pull/61): License date range UnitTest. Thanks [Anfernee Sodusta](https://github.com/dinosaurfiles)!
-- [PR #60](https://github.com/sendgrid/python-http-client/pull/60): Adds test for repo files. Thanks [Cheuk Yin Ng](https://github.com/cheukyin699)!
-- [PR #47](https://github.com/sendgrid/python-http-client/pull/47): Add .env_sample file. Thanks [Rod Xavier](https://github.com/rodxavier)!
-- [PR #66](https://github.com/sendgrid/python-http-client/pull/66): Update travis.yml to fail on Pep8 errors. Thanks [Stanley Ndagi](https://github.com/NdagiStanley)!
-- [PR #67](https://github.com/sendgrid/python-http-client/pull/67): Made python-http-client comply with autopep8. Thanks [Madhur Garg](https://github.com/Madhur96)!
-- [PR #81](https://github.com/sendgrid/python-http-client/pull/81): PEP8 updates. Thanks [~](https://github.com/delirious-lettuce)!
-- [PR #73](https://github.com/sendgrid/python-http-client/pull/73): Add CodeCov support to .travis.yml. Thanks [Senthil](https://github.com/senthilkumar-e)!
-- [PR #77](https://github.com/sendgrid/python-http-client/pull/77): Include code review in README.md. Thanks [Jared Scott](https://github.com/jlax47)!
-- [PR #87](https://github.com/sendgrid/python-http-client/pull/87): Add manifest that includes the license in sdist. Thanks [RohitK89](https://github.com/RohitK89)!
+- [PR #21](https://github.com/sendgrid/python-http-client/pull/21): Support timeout. Thanks, [George Kussumoto](https://github.com/georgeyk)!
+- [PR #22](https://github.com/sendgrid/python-http-client/pull/22): Client can be pickled and unpickled. Thanks, [Jussi Heikkilä](https://github.com/jussih)!
+- [PR #26](https://github.com/sendgrid/python-http-client/pull/26): Create CODE_OF_CONDUCT.md. Thanks, [Fredrik Svensson](https://github.com/SvenssonWeb)!
+- [PR #30](https://github.com/sendgrid/python-http-client/pull/30): Create TROUBLESHOOTING.md. Thanks, [Omer Ahmed Khan](https://github.com/OmerAhmedKhan)!
+- [PR #33](https://github.com/sendgrid/python-http-client/pull/33): Update README.md badges and license. Thanks, [Alfred Gutierrez](https://github.com/alfg)!
+- [PR #34](https://github.com/sendgrid/python-http-client/pull/34): Update .md files for SEO. Thanks, [Gustavo Siqueira](https://github.com/gugsrs)!
+- [PR #36](https://github.com/sendgrid/python-http-client/pull/36): Added more badges to README.md. Thanks,, [Shivam Agarwal](https://github.com/gr8shivam)!
+- [PR #41](https://github.com/sendgrid/python-http-client/pull/41): Added License link to README ToC. Thanks,, [Andrew Joshua Loria](https://github.com/ajloria)!
+- [PR #49](https://github.com/sendgrid/python-http-client/pull/49): Add USAGE.md. Thanks, [Adelmo Junior](https://github.com/noblehelm)!
+- [PR #43](https://github.com/sendgrid/python-http-client/pull/43): Add PULL_REQUEST_TEMPLATE. Thanks, [Aleksandr Sobolev](https://github.com/s0b0lev)!
+- [PR #50](https://github.com/sendgrid/python-http-client/pull/50): Add Docker files and update README. Thanks, [Stanley Ndagi](https://github.com/NdagiStanley)!
+- [PR #69](https://github.com/sendgrid/python-http-client/pull/69): Simplify GitHub PR template. Thanks, [Alex](https://github.com/pushkyn)!
+- [PR #61](https://github.com/sendgrid/python-http-client/pull/61): License date range UnitTest. Thanks, [Anfernee Sodusta](https://github.com/dinosaurfiles)!
+- [PR #60](https://github.com/sendgrid/python-http-client/pull/60): Adds test for repo files. Thanks, [Cheuk Yin Ng](https://github.com/cheukyin699)!
+- [PR #47](https://github.com/sendgrid/python-http-client/pull/47): Add .env_sample file. Thanks, [Rod Xavier](https://github.com/rodxavier)!
+- [PR #66](https://github.com/sendgrid/python-http-client/pull/66): Update travis.yml to fail on Pep8 errors. Thanks, [Stanley Ndagi](https://github.com/NdagiStanley)!
+- [PR #67](https://github.com/sendgrid/python-http-client/pull/67): Made python-http-client comply with autopep8. Thanks, [Madhur Garg](https://github.com/Madhur96)!
+- [PR #81](https://github.com/sendgrid/python-http-client/pull/81): PEP8 updates. Thanks, [~](https://github.com/delirious-lettuce)!
+- [PR #73](https://github.com/sendgrid/python-http-client/pull/73): Add CodeCov support to .travis.yml. Thanks, [Senthil](https://github.com/senthilkumar-e)!
+- [PR #77](https://github.com/sendgrid/python-http-client/pull/77): Include code review in README.md. Thanks, [Jared Scott](https://github.com/jlax47)!
+- [PR #87](https://github.com/sendgrid/python-http-client/pull/87): Add manifest that includes the license in sdist. Thanks, [RohitK89](https://github.com/RohitK89)!
 
 ### Fixed
-- [PR #24](https://github.com/sendgrid/python-http-client/pull/24): Fix Typo in CONTRIBUTING.md. Thanks [Cícero Pablo](https://github.com/ciceropablo)!
-- [PR #23](https://github.com/sendgrid/python-http-client/pull/23): Fix Typo in README.md. Thanks [Cícero Pablo](https://github.com/ciceropablo)!
-- [PR #28](https://github.com/sendgrid/python-http-client/pull/28): Fix Travis CI Build. Thanks [Kevin Anderson](https://github.com/kevinanderson1)!
-- [PR #40](https://github.com/sendgrid/python-http-client/pull/40): Update contributing and readme - fix typo, ToC. Thanks [Alex](https://github.com/pushkyn)!
-- [PR #54](https://github.com/sendgrid/python-http-client/pull/54): Fix code style issues. Thanks [Stephen James](https://github.com/StephenOrJames)!
-- [PR #82](https://github.com/sendgrid/python-http-client/pull/82): PEP8 updates. Thanks [~](https://github.com/delirious-lettuce)!
-- [PR #83](https://github.com/sendgrid/python-http-client/pull/83): Fix Travis build errors. Thanks [~](https://github.com/delirious-lettuce)!
-- [PR #84](https://github.com/sendgrid/python-http-client/pull/84): Fix docstring variable name. Thanks [~](https://github.com/delirious-lettuce)!
+- [PR #24](https://github.com/sendgrid/python-http-client/pull/24): Fix Typo in CONTRIBUTING.md. Thanks, [Cícero Pablo](https://github.com/ciceropablo)!
+- [PR #23](https://github.com/sendgrid/python-http-client/pull/23): Fix Typo in README.md. Thanks, [Cícero Pablo](https://github.com/ciceropablo)!
+- [PR #28](https://github.com/sendgrid/python-http-client/pull/28): Fix Travis CI Build. Thanks, [Kevin Anderson](https://github.com/kevinanderson1)!
+- [PR #40](https://github.com/sendgrid/python-http-client/pull/40): Update contributing and readme - fix typo, ToC. Thanks, [Alex](https://github.com/pushkyn)!
+- [PR #54](https://github.com/sendgrid/python-http-client/pull/54): Fix code style issues. Thanks, [Stephen James](https://github.com/StephenOrJames)!
+- [PR #82](https://github.com/sendgrid/python-http-client/pull/82): PEP8 updates. Thanks, [~](https://github.com/delirious-lettuce)!
+- [PR #83](https://github.com/sendgrid/python-http-client/pull/83): Fix Travis build errors. Thanks, [~](https://github.com/delirious-lettuce)!
+- [PR #84](https://github.com/sendgrid/python-http-client/pull/84): Fix docstring variable name. Thanks, [~](https://github.com/delirious-lettuce)!
 - Fix [Issue #86](https://github.com/sendgrid/python-http-client/issues/86): Error converting Response.to_dict.
 
 ## [3.0.0] - 2017-08-11
@@ -47,12 +47,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [2.4.0] - 2017-07-03
 ### Added
 - #19 Added support for slash. Created "to_dict" property in response object and exception class.
-- Thanks [Lucas Cardoso](https://github.com/MrLucasCardoso)!
+- Thanks, [Lucas Cardoso](https://github.com/MrLucasCardoso)!
 
 ## [2.3.0] - 2017-06-20
 ### Added
 - #17 Added support for error handling
-- Thanks [Dibya Prakash Das](https://github.com/dibyadas)!
+- Thanks, [Dibya Prakash Das](https://github.com/dibyadas)!
 
 ## [2.2.1] - 2016-08-10
 ### Fixed
@@ -65,7 +65,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [2.1.1] - 2016-07-08
 ### Fixed
 - [Allow multiple values for a parameter](https://github.com/sendgrid/python-http-client/pull/11)
-- Thanks [Chris Henry](https://github.com/chrishenry)!
+- Thanks, [Chris Henry](https://github.com/chrishenry)!
 
 ## [2.1.0] - 2016-06-03
 ### Added
@@ -82,14 +82,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [1.2.3] - 2016-03-01
 ### Added
 - Can now reuse part of the chaining construction for multiple urls/requests
-- Thanks to [Kevin Gillette](https://github.com/extemporalgenome)!
+- Thanks, to [Kevin Gillette](https://github.com/extemporalgenome)!
 - Update of request headers simplified
-- Thanks to [Matt Bernier](https://github.com/mbernier)
+- Thanks, to [Matt Bernier](https://github.com/mbernier)
 
 ## [1.1.3] - 2016-02-29
 ### Fixed
 - Various standardizations for commenting, syntax, pylint
-- Thanks to [Ian Douglas](https://github.com/iandouglas)!
+- Thanks, to [Ian Douglas](https://github.com/iandouglas)!
 
 ## [1.1.2] - 2016-02-29
 ### Fixed

CODE_OF_CONDUCT.md

@@ -9,7 +9,7 @@ Members of the community are open to collaboration, whether it's on pull request
 Members of the community are considerate of their peers, which include other contributors and users of SendGrid. We're thoughtful when addressing the efforts of others, keeping in mind that often the labor was completed with the intent of the good of the community. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views.
 
 ### Be Respectful
-Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues.  Overall, we're good to each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
+Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments, and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues.  Overall, we're good with each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
 
 ## Additional Guidance 
 

CONTRIBUTING.md

@@ -1,26 +1,34 @@
 Hello! Thank you for choosing to help contribute to one of the SendGrid open source projects. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.
 
-- [CLAs and CCLAs](#cla)
-- [Roadmap & Milestones](#roadmap)
+- [CLAs and CCLAs](#clas-and-cclas)
 - [Feature Request](#feature-request)
 - [Submit a Bug Report](#submit-a-bug-report)
+    - [Please use our Bug Report Template](#please-use-our-bug-report-template)
 - [Improvements to the Codebase](#improvements-to-the-codebase)
-- [Understanding the Code Base](#understanding-the-codebase)
+    - [Development Environment](#development-environment)
+        - [Install and Run Locally](#install-and-run-locally)
+            - [Prerequisites](#prerequisites)
+            - [Initial setup:](#initial-setup)
+            - [Execute:](#execute)
+- [Understanding the Code Base](#understanding-the-code-base)
 - [Testing](#testing)
 - [Testing Multiple Versions of Python](#testing-multiple-versions-of-python)
-- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
+    - [Prerequisites:](#prerequisites)
+    - [Initial setup:](#initial-setup-1)
+    - [Execute:](#execute-1)
+- [Style Guidelines & Naming Conventions](#style-guidelines--naming-conventions)
 - [Creating a Pull Request](#creating-a-pull-request)
 - [Code Reviews](#code-reviews)
 
 <a name="roadmap"></a>
-We use [Milestones](https://github.com/sendgrid/python-http-client/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/python-http-client/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.
 
 <a name="cla"></a>
 ## CLAs and CCLAs
 
 Before you get started, SendGrid requires that a SendGrid Contributor License Agreement (CLA) be filled out by every contributor to a SendGrid open source project.
 
-Our goal with the CLA is to clarify the rights of our contributors and reduce other risks arising from inappropriate contributions.  The CLA also clarifies the rights SendGrid holds in each contribution and helps to avoid misunderstandings over what rights each contributor is required to grant to SendGrid when making a contribution.  In this way the CLA encourages broad participation by our open source community and helps us build strong open source projects, free from any individual contributor withholding or revoking rights to any contribution.
+Our goal with the CLA is to clarify the rights of our contributors and reduce other risks arising from inappropriate contributions.  The CLA also clarifies the rights SendGrid holds in each contribution and helps to avoid misunderstandings over what rights each contributor is required to grant to SendGrid when making a contribution.  In this way, the CLA encourages broad participation by our open source community and helps us build strong open source projects, free from any individual contributor withholding or revoking rights to any contribution.
 
 SendGrid does not merge a pull request made against a SendGrid open source project until that pull request is associated with a signed CLA. Copies of the CLA are available [here](https://gist.github.com/SendGridDX/98b42c0a5d500058357b80278fde3be8#file-sendgrid_cla).
 
@@ -47,8 +55,8 @@ A software bug is a demonstrable issue in the code base. In order for us to diag
 
 Before you decide to create a new issue, please try the following:
 
-1. Check the GitHub issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
-2. Update to the latest version of this code and check if issue has already been fixed
+1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
+2. Update to the latest version of this code and check if the issue has already been fixed
 3. Copy and fill in the Bug Report Template we have provided below
 
 ### Please use our Bug Report Template
@@ -187,6 +195,7 @@ Please run your code through:
    ```
 
 3. Create a new topic branch off the `development` branch to
+
    contain your feature, change, or fix:
 
    ```bash
@@ -196,7 +205,7 @@ Please run your code through:
 
 4. Commit your changes in logical chunks. Please adhere to these [git commit
    message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
-   or your code is unlikely be merged into the main project. Use Git's
+   or your code is unlikely to be merged into the main project. Use Git's
    [interactive rebase](https://help.github.com/articles/interactive-rebase)
    feature to tidy up your commits before making them public.
 

TROUBLESHOOTING.md

@@ -7,7 +7,7 @@
 
 When debugging or testing, it may be useful to examine the raw request body.
 
-You can do this just after call `response = client.your.api._(param).call.<METHOD>` Where <METHOD> can be `get()`, `post()`, `patch()` and `post()`.
+You can do this just after the call `response = client.your.api._(param).call.<METHOD>` Where <METHOD> can be `get()`, `post()`, `patch()` and `post()`.
 
 ```python
 print(response.body)

USAGE.md

@@ -9,9 +9,11 @@ request_headers = {
     "Authorization": 'Bearer {0}'.format(api_key)
 }
 version = 3
-client = python_http_client.Client(host=host,
-                                   request_headers=request_headers,
-version=version)
+client = python_http_client.Client(
+    host=host,
+    request_headers=request_headers,
+    version=version
+)
 ```
 
 # Table of Contents

USE_CASES.md

@@ -0,0 +1 @@
+This document provides examples for specific use cases. Please [open an issue](https://github.com/sendgrid/python-http-client/issues) or make a pull request for any use cases you would like us to document here. Thank you!