Merge pull request #8 from chirag-jn/dev

Add support for App Passwords and secure app access

README.md

@@ -1,5 +1,5 @@
 # Notipyer
-##### Notification triggers for Python
+##### Notification Triggers for Python
 Send async email notifications via Python. Get updates/crashlogs from your scripts with ease. 
 
 ## Installation
@@ -10,15 +10,19 @@ pip install notipyer
 ```
 
 ## Email Notifications
-Notipyer currently supports Gmail accounts as senders. To allow the library to use your gmail account, make the following changes:
-1. Turn off 2-Step authentication. [Ref](https://support.google.com/accounts/answer/1064203)
-2. Turn on "Less Secure App Access" [here](https://myaccount.google.com/intro/security)
+Notipyer currently supports Gmail accounts as senders. To allow the library to use your Gmail account, make the following changes:
+
+1. Turn on 2-Step authentication. [Ref](https://support.google.com/accounts/answer/185839)
+2. Create an app password. [Ref](https://support.google.com/mail/answer/185833)
+3. While creating an app password, select app as "Other (Custom name)" and enter a name of your choice. 
+4. Use the password obtained from app password for the configuration step below.
+
 ### Configuration
 ```python
 from notipyer.email_notify import set_email_config
 
 SENDER_EMAIL = '[email protected]'
-SENDER_PASS = 'password'
+SENDER_PASS = 'my_app_password'
 set_email_config(SENDER_EMAIL, SENDER_PASS)
 ```
 ### Sending Email

notipyer/__init__.py

@@ -1 +1 @@
-__version__ = '0.1.3'
+__version__ = '0.1.5'

notipyer/email_notify.py

@@ -4,7 +4,6 @@
 import smtplib
 
 SMTP_GMAIL_URL = 'smtp.gmail.com'
-SMTP_GMAIL_PORT = 587
 
 mail_cred = credentials()
 
@@ -24,12 +23,11 @@ def set_email_config(email, password):
 @Async
 def send_email(subject, message, to_addr, cc_addr=None, bcc_addr=None):
     global mail_cred
-    global SMTP_GMAIL_URL, SMTP_GMAIL_PORT
+    global SMTP_GMAIL_URL
 
     to_addr, cc_addr, bcc_addr = _check_recipients(to_addr, cc_addr, bcc_addr)
 
-    client = smtplib.SMTP(SMTP_GMAIL_URL, SMTP_GMAIL_PORT)
-    client.starttls()
+    client = smtplib.SMTP_SSL(SMTP_GMAIL_URL)
     client = _login_client(client)
     recipients, email_body = _build_email(subject, message, mail_cred.EMAIL_ID, to_addr, cc_addr, bcc_addr)
     client.sendmail(mail_cred.EMAIL_ID, recipients, email_body)
@@ -40,7 +38,7 @@ def _login_client(client):
     try:
         client.login(mail_cred.EMAIL_ID, mail_cred.EMAIL_PASS)
         return client
-    except smtplib.SMTPAuthenticationError as _:
+    except smtplib.SMTPAuthenticationError:
         raise GmailLoginException()
 
 

setup.py

@@ -8,7 +8,7 @@
 setup(
     name='notipyer',
     version=version,
-    description='Notification API for Python',
+    description='Notification Triggers for Python',
     long_description=long_description,
     long_description_content_type="text/markdown",
     author='Chirag Jain',

tests/.gitignore

@@ -0,0 +1 @@
+credentials.py

tests/credentials.py.sample

@@ -0,0 +1,3 @@
+username = "[email protected]"
+password = "myapppassword"
+target_email = "[email protected]"

tests/test_email_send.py

@@ -0,0 +1,6 @@
+from credentials import *
+from notipyer.email_notify import send_email, set_email_config
+
+set_email_config(username, password)
+
+send_email("my_subject", "my_content", [target_email])