Version Bump v2.0.1

thinkingserious · thinkingserious · commit b4f5738774c3 · 2016-03-02T21:43:25.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.1.0] - 2016-03-02 ##
+
+### Added ###
+
+- you can now pass an apikey to the SendGridAPIClient, per issue [#168](https://github.com/sendgrid/sendgrid-python/issues/168). Thanks [Matt](https://github.com/mbernier)!
+
 ## [2.0.0] - 2016-03-01 ##
 
 ### Added ###
diff --git a/README.md b/README.md
@@ -18,9 +18,9 @@ or
 - [SMTAPI-Python](https://github.com/sendgrid/smtpapi-python)
 - [Python-HTTP-Client](https://github.com/sendgrid/python-http-client)
 
-## Environment Variables
+## Environment Variables (for v3 Web API)
 
-[Sample .env](https://github.com/sendgrid/sendgrid-python/blob/python_http_client/.env_sample), please rename to `.env` and add your [SendGrid API Key](https://app.sendgrid.com/settings/api_keys).
+[Sample .env](https://github.com/sendgrid/sendgrid-python/blob/python_http_client/.env_sample), please rename to `.env` and add your [SendGrid API Key](https://app.sendgrid.com/settings/api_keys), or you can pass your API Key into the SendGridClient constructor.
 
 # Quick Start
 
@@ -31,6 +31,7 @@ import sendgrid
 
 sg = sendgrid.SendGridClient('YOUR_SENDGRID_API_KEY')
 
+
 message = sendgrid.Mail()
 message.add_to('John Doe <john@email.com>')
 message.set_subject('Example')
@@ -52,7 +53,8 @@ print(status, msg)
 ```python
 import sendgrid
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 response = sg.client.api_keys.get()
 print(response.status_code)
diff --git a/USAGE.md b/USAGE.md
diff --git a/examples/apikey/apikey.py b/examples/apikey/apikey.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Create API keys #
diff --git a/examples/apikeys/apikeys.py b/examples/apikeys/apikeys.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # List all API Keys belonging to the authenticated user #
diff --git a/examples/asm/asm.py b/examples/asm/asm.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Create a Group #
diff --git a/examples/browsers/browsers.py b/examples/browsers/browsers.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Retrieve email statistics by browser.  #
diff --git a/examples/campaigns/campaigns.py b/examples/campaigns/campaigns.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Create a Campaign #
diff --git a/examples/categories/categories.py b/examples/categories/categories.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Get categories #
diff --git a/examples/clients/clients.py b/examples/clients/clients.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Retrieve email statistics by client type. #
diff --git a/examples/contactdb/contactdb.py b/examples/contactdb/contactdb.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Create a Custom Field #
diff --git a/examples/devices/devices.py b/examples/devices/devices.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Retrieve email statistics by device type. #
diff --git a/examples/geo/geo.py b/examples/geo/geo.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Retrieve email statistics by country and state/province. #
diff --git a/examples/ips/ips.py b/examples/ips/ips.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # List all IPs #
diff --git a/examples/mail/mail.py b/examples/mail/mail.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Create a batch ID #
diff --git a/examples/mailboxproviders/mailboxproviders.py b/examples/mailboxproviders/mailboxproviders.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Retrieve email statistics by mailbox provider. #
diff --git a/examples/mailsettings/mailsettings.py b/examples/mailsettings/mailsettings.py
@@ -2,10 +2,11 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
-# Get all mail settings #
+# Retrieve all mail settings #
 # GET /mail_settings #
 
 params = {'limit': 0, 'offset': 0}
@@ -25,7 +26,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get address whitelist mail settings #
+# Retrieve address whitelist mail settings #
 # GET /mail_settings/address_whitelist #
 
 response = sg.client.mail_settings.address_whitelist.get()
@@ -44,7 +45,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get BCC mail settings #
+# Retrieve all BCC mail settings #
 # GET /mail_settings/bcc #
 
 response = sg.client.mail_settings.bcc.get()
@@ -63,7 +64,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get bounce purge mail settings #
+# Retrieve bounce purge mail settings #
 # GET /mail_settings/bounce_purge #
 
 response = sg.client.mail_settings.bounce_purge.get()
@@ -82,7 +83,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get footer mail settings [params can be null?] #
+# Retrieve footer mail settings #
 # GET /mail_settings/footer #
 
 response = sg.client.mail_settings.footer.get()
@@ -101,7 +102,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get forward bounce mail settings #
+# Retrieve forward bounce mail settings #
 # GET /mail_settings/forward_bounce #
 
 response = sg.client.mail_settings.forward_bounce.get()
@@ -120,7 +121,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get forward spam mail settings #
+# Retrieve forward spam mail settings #
 # GET /mail_settings/forward_spam #
 
 response = sg.client.mail_settings.forward_spam.get()
@@ -139,7 +140,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get plain content mail settings #
+# Retrieve plain content mail settings #
 # GET /mail_settings/plain_content #
 
 response = sg.client.mail_settings.plain_content.get()
@@ -158,7 +159,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get spam check mail settings #
+# Retrieve spam check mail settings #
 # GET /mail_settings/spam_check #
 
 response = sg.client.mail_settings.spam_check.get()
@@ -177,7 +178,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get template mail settings #
+# Retrieve legacy template mail settings #
 # GET /mail_settings/template #
 
 response = sg.client.mail_settings.template.get()
diff --git a/examples/partnersettings/partnersettings.py b/examples/partnersettings/partnersettings.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Returns a list of all partner settings. #
diff --git a/examples/scopes/scopes.py b/examples/scopes/scopes.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Returns a list of scopes for which this user has access. #
diff --git a/examples/stats/stats.py b/examples/stats/stats.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Retrieve global email statistics #
diff --git a/examples/subusers/subusers.py b/examples/subusers/subusers.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Create Subuser #
diff --git a/examples/suppression/suppression.py b/examples/suppression/suppression.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # List all bounces #
diff --git a/examples/templates/templates.py b/examples/templates/templates.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Create a transactional template. #
diff --git a/examples/trackingsettings/trackingsettings.py b/examples/trackingsettings/trackingsettings.py
@@ -2,10 +2,11 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
-# Get Tracking Settings #
+# Retrieve Tracking Settings #
 # GET /tracking_settings #
 
 params = {'limit': 0, 'offset': 0}
@@ -25,7 +26,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get Click Track Settings #
+# Retrieve Click Track Settings #
 # GET /tracking_settings/click #
 
 response = sg.client.tracking_settings.click.get()
@@ -44,7 +45,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get Google Analytics Settings #
+# Retrieve Google Analytics Settings #
 # GET /tracking_settings/google_analytics #
 
 response = sg.client.tracking_settings.google_analytics.get()
@@ -82,7 +83,7 @@
 print(response.response_headers)
 
 ##################################################
-# Get Subscription Tracking Settings #
+# Retrieve Subscription Tracking Settings #
 # GET /tracking_settings/subscription #
 
 response = sg.client.tracking_settings.subscription.get()
diff --git a/examples/user/user.py b/examples/user/user.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Get a user's account information. #
diff --git a/examples/whitelabel/whitelabel.py b/examples/whitelabel/whitelabel.py
@@ -2,7 +2,8 @@
 import json
 import os
 
-sg = sendgrid.SendGridAPIClient()
+sg = sendgrid.SendGridAPIClient(apikey='YOUR_SENDGRID_API_KEY')
+# You can also store your API key an .env variable 'SENDGRID_API_KEY'
 
 ##################################################
 # Create a domain whitelabel. #
diff --git a/sendgrid/client.py b/sendgrid/client.py
@@ -15,7 +15,7 @@ def __init__(self, **opts):
         """
         path =  '{0}/..'.format(os.path.abspath(os.path.dirname(__file__)))
         python_http_client.Config(path)
-        self._apikey = os.environ.get('SENDGRID_API_KEY')
+        self._apikey = opts.get('apikey', os.environ.get('SENDGRID_API_KEY'))
         self.useragent = 'sendgrid/{0};python_v3'.format(__version__)
         self.host = opts.get('host', 'https://api.sendgrid.com')
         self.path = opts.get('path', os.path.abspath(os.path.dirname(__file__)))
diff --git a/sendgrid/version.py b/sendgrid/version.py
