Added spinx docs and updated draft parameter

Author: aydrian

docs/api/templates.rst

@@ -0,0 +1,7 @@
+.. module:: sparkpost.templates
+
+:mod:`sparkpost.templates`
+=============================
+
+.. autoclass:: Templates
+   :members:

docs/index.rst

@@ -32,7 +32,7 @@ Alternatively, you can pass the API key to the SparkPost class:
 
     from sparkpost import SparkPost
     sp = SparkPost('YOUR API KEY')
-    
+
 .. _API & SMTP: https://app.sparkpost.com/configuration/credentials
 
 
@@ -45,6 +45,7 @@ The following resources are available in python-sparkpost:
     :maxdepth: 1
 
     resources/metrics
+    resources/templates
     resources/transmissions
 
 
@@ -77,4 +78,3 @@ Contribute
 
 .. _`the repository`: http://github.com/SparkPost/python-sparkpost
 .. _AUTHORS: https://github.com/SparkPost/python-sparkpost/blob/master/AUTHORS.rst
-

docs/resources/templates.rst

@@ -0,0 +1,69 @@
+Templates
+=============
+
+Let's use the underlying `templates API`_ to create a template:
+
+.. code-block:: python
+
+    from sparkpost import SparkPost
+
+    sp = SparkPost()
+
+    response = sp.templates.create(
+        id='TEST_ID',
+        name='Test Template',
+        from_email='[email protected]',
+        subject='Test email template!',
+        html='<b>This is a test email template!</b>'
+    )
+
+    print response
+    # outputs {u'id': u'TEST_ID'}
+
+.. _templates API: https://www.sparkpost.com/api#/reference/templates
+
+
+Retrieve a template
+-----------------------
+
+.. code-block:: python
+
+    from sparkpost import SparkPost
+
+    sp = SparkPost()
+
+    sp.templates.get('my-template-id')
+
+
+List all templates
+----------------------
+
+.. code-block:: python
+
+    from sparkpost import SparkPost
+
+    sp = SparkPost()
+
+    sp.templates.list()
+
+
+API reference
+-------------
+
+:doc:`/api/templates`
+
+
+Further examples
+----------------
+
+See the `python-sparkpost templates examples`_.
+
+.. _python-sparkpost templates examples: https://github.com/SparkPost/python-sparkpost/tree/master/examples/templates
+
+
+Additional documentation
+------------------------
+
+See the `SparkPost Templates API Reference`_.
+
+.. _SparkPost Templates API Reference: https://www.sparkpost.com/api#/reference/templates

sparkpost/templates.py

@@ -124,12 +124,12 @@ def delete(self, template_id):
         results = self.request('DELETE', uri)
         return results
 
-    def get(self, template_id, is_draft=None):
+    def get(self, template_id, draft=None):
         """
         Get a template by ID
 
         :param str template_id: ID of the template you want to retrieve
-        :param bool is_draft: Defaults to None. If True, returns the most
+        :param bool draft: Defaults to None. If True, returns the most
             recent draft template. If False, returns the most recent published
             template. If None, returns the most recent template version
             regardless of draft or published.
@@ -139,8 +139,8 @@ def get(self, template_id, is_draft=None):
         """
         uri = "%s/%s" % (self.uri, template_id)
         params = {}
-        if is_draft is not None:
-            params['draft'] = str(is_draft).lower()
+        if draft is not None:
+            params['draft'] = str(draft).lower()
         results = self.request('GET', uri, params=params)
         return results
 
@@ -154,15 +154,15 @@ def list(self):
         results = self.request('GET', self.uri)
         return results
 
-    def preview(self, template_id, substitution_data, is_draft=None):
+    def preview(self, template_id, substitution_data, draft=None):
         """
         Get a preivew of your template by ID with the
         provided substitution_data
 
         :param str template_id: ID of the template you want to retrieve
         :param dict substitution_data: data to be substituted in the
             template content
-        :param bool is_draft: Defaults to None. If True, previews the most
+        :param bool draft: Defaults to None. If True, previews the most
             recent draft template. If False, previews the most recent published
             template. If None, previews the most recent template version
             regardless of draft or published.
@@ -173,8 +173,8 @@ def preview(self, template_id, substitution_data, is_draft=None):
         """
         uri = "%s/%s/preview" % (self.uri, template_id)
         params = {}
-        if is_draft is not None:
-            params['draft'] = str(is_draft).lower()
+        if draft is not None:
+            params['draft'] = str(draft).lower()
         results = self.request('POST',
                                uri,
                                params=params,

test/test_templates.py

@@ -179,7 +179,7 @@ def test_success_preview():
 
 
 @responses.activate
-def test_success_preview_with_is_draft():
+def test_success_preview_with_draft():
     responses.add(
         responses.POST,
         'https://api.sparkpost.com/api/v1/templates/foobar/preview?draft=true',