Merge pull request #5 from cmdotcom/improve_examples

Improve examples

Author: JorisPenningsCM

.gitignore

@@ -0,0 +1,2 @@
+*.idea
+venv

CMText/version.py

@@ -1,2 +1,2 @@
 #project Version
-__version__ = '1.1.2'
+__version__ = '1.1.3'

Examples/Multiple_Message_Example.py

@@ -1,8 +1,14 @@
+import os
 from CMText.TextClient import TextClient
 
-# Message to be send
-message = 'Examples message to be send'
-message2 = 'Examples 2 message to be send'
+# fetch the API key from environment variables
+UNIQUE_API_KEY = os.getenv("CM_API_KEY")
+if UNIQUE_API_KEY is None:
+    print('Please fill an environment variable named CM_API_KEY with your API key.')
+
+# Message to be sent
+message = 'Examples message to be sent'
+message2 = 'Examples 2 message to be sent'
 
 # Recipients
 to = ['003156789000', '002134567890']

Examples/Rich_Message_Example.py

@@ -1,9 +1,15 @@
+import os
 from CMText.TextClient import TextClient
 
-# Message to be send
-message = 'Examples message to be send'
+# fetch the API key from environment variables
+UNIQUE_API_KEY = os.getenv("CM_API_KEY")
+if UNIQUE_API_KEY is None:
+    print('Please fill an environment variable named CM_API_KEY with your API key.')
 
-# Media to be send
+# Message to be sent
+message = 'Examples message to be sent'
+
+# Media to be sent
 media = {
             "mediaName": "conversational-commerce",
             "mediaUri": "https://www.cm.com/cdn/cm/cm.png",
@@ -26,4 +32,4 @@
 response = client.send()
 
 # Print response
-print(response.text)
+print(response.text)

Examples/Single_Message_Example.py

@@ -1,7 +1,13 @@
+import os
 from CMText.TextClient import TextClient
 
-# Message to be send
-message = 'Examples message to be send'
+# fetch the API key from environment variables
+UNIQUE_API_KEY = os.getenv("CM_API_KEY")
+if UNIQUE_API_KEY is None:
+    print('Please fill an environment variable named CM_API_KEY with your API key.')
+
+# Message to be sent
+message = 'Examples message to be sent'
 
 # Recipients
 to = ['003156789000', '002134567890']

Examples/Whatsapp_Template_Message_Example.py

@@ -1,19 +1,22 @@
+import os
 from CMText.TextClient import TextClient
 from CMText.WhatsappTemplate import WhatsappTemplate
 
-# Your api-Key
-key = 'Your-Key'
+# fetch the API key from environment variables
+UNIQUE_API_KEY = os.getenv("CM_API_KEY")
+if UNIQUE_API_KEY is None:
+    print('Please fill an environment variable named CM_API_KEY with your API key.')
 
 # Recipients
-to = ['00123456789','00986837265']
+to = ['00123456789', '00986837265']
 
 # Template
 template_namespace = "Your_Template_Namespace"
 template_element_name = "Your_Template_Name"
 template = WhatsappTemplate(template_namespace, template_element_name)
 
 # Instantiate client with your own api-key
-client = TextClient(apikey=key)
+client = TextClient(apikey=UNIQUE_API_KEY)
 
 # Add message to queue
 client.AddWhatsappTemplateMessage(from_='pythonSDK', to=to, template=template)

Examples/Whatsapp_Template_with Media.py

@@ -1,11 +1,14 @@
+import os
 from CMText.TextClient import TextClient
 from CMText.WhatsappTemplate import WhatsappTemplate
 
-# Your api-Key
-key = 'Your-Key'
+# fetch the API key from environment variables
+UNIQUE_API_KEY = os.getenv("CM_API_KEY")
+if UNIQUE_API_KEY is None:
+    print('Please fill an environment variable named CM_API_KEY with your API key.')
 
 # Recipients
-to = ['00123456789','00986837265']
+to = ['00123456789', '00986837265']
 
 # Template
 template_namespace = "Your_Template_Namespace"
@@ -50,4 +53,4 @@
 response = client.send()
 
 # Response is an object of type: https://www.w3schools.com/python/ref_requests_response.asp
-print(response.text)
+print(response.text)

Examples/Whatsapp_Template_with_Components.py

@@ -1,11 +1,14 @@
+import os
 from CMText.TextClient import TextClient
 from CMText.WhatsappTemplate import WhatsappTemplate
 
-# Your api-Key
-key = 'Your-Key'
+# fetch the API key from environment variables
+UNIQUE_API_KEY = os.getenv("CM_API_KEY")
+if UNIQUE_API_KEY is None:
+    print('Please fill an environment variable named CM_API_KEY with your API key.')
 
 # Recipients
-to = ['00123456789','00986837265']
+to = ['00123456789', '00986837265']
 
 # Template
 template_namespace = "Your_Template_Namespace"
@@ -35,7 +38,7 @@
 template = WhatsappTemplate(template_namespace, template_element_name, template_parameters)
 
 # Instantiate client with your own api-key
-client = TextClient(apikey=key)
+client = TextClient(apikey=UNIQUE_API_KEY)
 
 # Add message to queue
 client.AddWhatsappTemplateMessage(from_='pythonSDK', to=to, template=template)
@@ -44,4 +47,4 @@
 response = client.send()
 
 # Response is an object of type: https://www.w3schools.com/python/ref_requests_response.asp
-print(response.text)
+print(response.text)