Merge pull request #52 from SparkPost/ISSUE-51

Remove YOUR API KEY references from examples
SparkPost · Oct 13, 2015 · bb24f87 · bb24f87
2 parents 79edc13 + 6b24b98
commit bb24f87
Show file tree

Hide file tree

Showing 26 changed files with 90 additions and 77 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,11 @@
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.py]
+indent_style = space
+indent_size = 4
diff --git a/examples/recipient_lists/create_recipient_list.py b/examples/recipient_lists/create_recipient_list.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 response = sp.recipient_lists.create(
     id='UNIQUE_TEST_ID',
     name='Test Recipient list',

diff --git a/examples/recipient_lists/delete_recipient_list.py b/examples/recipient_lists/delete_recipient_list.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 result = sp.recipient_lists.delete('list_id')
 print result
diff --git a/examples/recipient_lists/get_recipient_list.py b/examples/recipient_lists/get_recipient_list.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 recipient_list = sp.recipient_lists.get('list_id')
 print recipient_list
diff --git a/examples/recipient_lists/get_recipient_list_with_recipients.py b/examples/recipient_lists/get_recipient_list_with_recipients.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 recipient_list = sp.recipient_lists.get('list_id', True)
 print recipient_list
diff --git a/examples/recipient_lists/list_recipient_lists.py b/examples/recipient_lists/list_recipient_lists.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 recipient_lists = sp.recipient_lists.list()
 print recipient_lists
diff --git a/examples/recipient_lists/update_recipient_list.py b/examples/recipient_lists/update_recipient_list.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 response = sp.recipient_lists.update(
     'EXISTING_TEST_ID',
     name='Test Recipient list',

diff --git a/examples/suppression_list/create_suppression_entries_bulk.py b/examples/suppression_list/create_suppression_entries_bulk.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 recipients = [
     {
         'email': 'test1@test.com',

diff --git a/examples/suppression_list/create_suppression_entry.py b/examples/suppression_list/create_suppression_entry.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 result = sp.suppression_list.create({
     'email': 'test@test.com',
     'transactional': False,

diff --git a/examples/suppression_list/delete_suppression_entry.py b/examples/suppression_list/delete_suppression_entry.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 result = sp.suppression_list.delete('test@test.com')
 print result
diff --git a/examples/suppression_list/get_suppression_entry.py b/examples/suppression_list/get_suppression_entry.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 entry = sp.suppression_list.get('test@test.com')
 print entry
diff --git a/examples/suppression_list/list_suppression_entries.py b/examples/suppression_list/list_suppression_entries.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 results = sp.suppression_list.list(
     from_date='2015-05-07T00:00:00+0000',
     to_date='2015-05-07T23:59:59+0000',

diff --git a/examples/suppression_list/update_suppression_entries_bulk.py b/examples/suppression_list/update_suppression_entries_bulk.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 recipients = [
     {
         'email': 'test1@test.com',

diff --git a/examples/suppression_list/update_suppression_enty.py b/examples/suppression_list/update_suppression_enty.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 result = sp.suppression_list.update({
     'email': 'test@test.com',
     'transactional': False,

diff --git a/examples/templates/create_template.py b/examples/templates/create_template.py
@@ -1,11 +1,13 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
+
 response = sp.templates.create(
     id='TEST_ID',
     name='Test Template',
     from_email='test@test.com',
     subject='Test email template!',
     html='<b>This is a test email template!</b>'
 )
+
 print response
diff --git a/examples/templates/delete_template.py b/examples/templates/delete_template.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 result = sp.templates.delete('template_id')
 print result
diff --git a/examples/templates/get_template.py b/examples/templates/get_template.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 template = sp.templates.get('template_id')
 print template
diff --git a/examples/templates/list_templates.py b/examples/templates/list_templates.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 template_list = sp.templates.list()
 print template_list
diff --git a/examples/templates/preview_draft_template.py b/examples/templates/preview_draft_template.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 sub_data = {
     'first_name': 'John',
     'last_name': 'Doe'

diff --git a/examples/templates/preview_template.py b/examples/templates/preview_template.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 sub_data = {
     'first_name': 'John',
     'last_name': 'Doe'

diff --git a/examples/templates/update_template.py b/examples/templates/update_template.py
@@ -1,6 +1,6 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 response = sp.templates.update(
     'TEST_ID',
     name='Test Template',

diff --git a/examples/transmissions/find_transmission.py b/examples/transmissions/find_transmission.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
-trans = sp.transmission.get('transmission_id')
-print trans
+sp = SparkPost()
+transmission = sp.transmission.get('transmission_id')
+print transmission
diff --git a/examples/transmissions/get_transmissions.py b/examples/transmissions/get_transmissions.py
@@ -1,5 +1,5 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 transmission_list = sp.transmission.list()
 print transmission_list
diff --git a/examples/transmissions/send_transmission.py b/examples/transmissions/send_transmission.py
@@ -1,35 +1,35 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 
 response = sp.transmission.send(
-  recipients = [
-    'postmaster@example.com',
-    'you@me.com',
-    {
-      'address': {
-        'email': 'john.doe@example.com',
-        'name': 'John Doe'
-      }
-    }
-  ],
-  html = '<p>Hello world {{name}}</p>',
-  text = 'Hello world {{name}}',
-  from_email = 'test@sparkpostbox.com',
-  subject = 'Example Script',
-  description = 'contrived example',
-  custom_headers = {
-    'X-CUSTOM-HEADER': 'foo bar'
-  },
-  track_opens = True,
-  track_clicks = True,
-  campaign = 'sdk example',
-  metadata = {
-    'key': 'value',
-    'arbitrary': 'values'
-  },
-  substitution_data = {
-    'name': 'Example User'
-  },
-  reply_to = 'no-reply@sparkpostmail.com'
+    recipients=[
+        'postmaster@example.com',
+        'you@me.com',
+        {
+            'address': {
+                'email': 'john.doe@example.com',
+                'name': 'John Doe'
+            }
+        }
+    ],
+    html='<p>Hello world {{name}}</p>',
+    text='Hello world {{name}}',
+    from_email='test@sparkpostbox.com',
+    subject='Example Script',
+    description='contrived example',
+    custom_headers={
+        'X-CUSTOM-HEADER': 'foo bar'
+    },
+    track_opens=True,
+    track_clicks=True,
+    campaign='sdk example',
+    metadata={
+        'key': 'value',
+        'arbitrary': 'values'
+    },
+    substitution_data={
+        'name': 'Example User'
+    },
+    reply_to='no-reply@sparkpostmail.com'
 )
diff --git a/examples/transmissions/transmission_stored_list.py b/examples/transmissions/transmission_stored_list.py
@@ -1,24 +1,24 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 
 response = sp.transmission.send(
-  recipient_list = 'my_list',
-  html = '<p>Hello world {{name}}</p>',
-  text = 'Hello world {{name}}',
-  from_email = 'test@sparkpostbox.com',
-  subject = 'Example Script',
-  description = 'contrived example',
-  custom_headers = {
-    'X-CUSTOM-HEADER': 'foo bar'
-  },
-  campaign = 'sdk example',
-  metadata = {
-    'key': 'value',
-    'arbitrary': 'values'
-  },
-  substitution_data = {
-    'name': 'Example User'
-  },
-  reply_to = 'no-reply@sparkpostmail.com'
+    recipient_list='my_list',
+    html='<p>Hello world {{name}}</p>',
+    text='Hello world {{name}}',
+    from_email='test@sparkpostbox.com',
+    subject='Example Script',
+    description='contrived example',
+    custom_headers={
+        'X-CUSTOM-HEADER': 'foo bar'
+    },
+    campaign='sdk example',
+    metadata={
+        'key': 'value',
+        'arbitrary': 'values'
+    },
+    substitution_data={
+        'name': 'Example User'
+    },
+    reply_to='no-reply@sparkpostmail.com'
 )
diff --git a/examples/transmissions/transmission_stored_template.py b/examples/transmissions/transmission_stored_template.py
@@ -1,9 +1,9 @@
 from sparkpost import SparkPost
 
-sp = SparkPost('YOUR API KEY')
+sp = SparkPost()
 
 response = sp.transmission.send(
-  recipients = ['you@me.com'],
-  template = 'my-template-id',
-  use_draft_template = True
+    recipients=['you@me.com'],
+    template='my-template-id',
+    use_draft_template=True
 )