Merge pull request #10 from chirag-jn/dev

Support for Slack Notifications

Author: chirag-jn

.github/workflows/package-build.yml

@@ -7,7 +7,7 @@ on:
   push:
     branches: [dev, workflows]
   pull_request:
-    branches: [dev, master]
+    branches: [master]
 
 jobs:
   build:

.github/workflows/python-linter.yml

@@ -7,7 +7,7 @@ on:
   push:
     branches: [dev, workflows]
   pull_request:
-    branches: [dev, master]
+    branches: [master]
 
 jobs:
   build:

README.md

@@ -1,6 +1,6 @@
 # Notipyer
-##### Notification Triggers for Python
-Send async email notifications via Python. Get updates/crashlogs from your scripts with ease. 
+#### Notification Triggers for Python
+Send async email and slack notifications via Python. Get updates/crashlogs from your scripts with ease. 
 
 ## Installation
 ```bash
@@ -16,7 +16,8 @@ Notipyer currently supports Gmail accounts as senders. To allow the library to u
 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.
-   
+5. More information can be obtained on the wiki page [here](https://github.com/chirag-jn/notipyer/wiki/Notifications-via-Email)
+
 ### Configuration
 ```python
 from notipyer.email_notify import set_email_config
@@ -38,5 +39,30 @@ bcc_recipients = ['[email protected]', '[email protected]'] # Can be N
 send_email(subject, body, to_recipients, cc_recipients, bcc_recipients)
 ```
 
+## Slack Notifications
+Notipyer currently supports running a single workplace install only. 
+   
+For setting up token keys for using slack notifications, follow the wiki page [here](https://github.com/chirag-jn/notipyer/wiki/Notifications-via-Slack)
+   
+### Configuration
+```python
+from notipyer.slack_notify import set_slack_token_config
+
+# Follow the wiki for getting the bot token
+BOT_TOKEN = 'xoxb-12345678990123-1234567890123-abcdefghijklmnopqrstuvwx' 
+set_slack_token_config(BOT_TOKEN)
+```
+### Sending Message
+```python
+from notipyer.slack_notify import send_message
+
+# the bot should be added to the channel
+channel = 'my-channel-name'
+message = 'my-message'
+
+set_slack_token_config(SLACK_TOKEN)
+send_message(channel, message)
+```
+
 ## Contact
 [Chirag Jain](https://github.com/chirag-jn)

examples/slack_example.py

@@ -0,0 +1,9 @@
+from notipyer.slack_notify import set_slack_token_config, send_message
+
+SLACK_TOKEN = 'xoxb-12345678990123-1234567890123-abcdefghijklmnopqrstuvwx'
+
+channel = 'my-channel-name'
+message = 'my-message'
+
+set_slack_token_config(SLACK_TOKEN)
+send_message(channel, message)

notipyer/__init__.py

@@ -1 +1,16 @@
-__version__ = '0.1.5'
+from .credential_handler import credentials
+
+__version__ = '0.2.0'
+__name__ = 'Notipyer'
+__short_desc__ = 'Notification Triggers for Python'
+__url__ = 'https://github.com/chirag-jn/notipyer'
+
+
+creds = None
+
+
+def _get_creds():
+    global creds
+    if creds is None:
+        creds = credentials()
+    return creds

notipyer/credential_handler.py

@@ -1,6 +1,7 @@
 class credentials:
     EMAIL_ID = ''
     EMAIL_PASS = ''
+    SLACK_TOKEN = ''
 
     def __init__(self):
         pass
@@ -9,3 +10,7 @@ def __init__(self):
 def _set_email_credentials(cred_obj, email, password):
     cred_obj.EMAIL_ID = email
     cred_obj.EMAIL_PASS = password
+
+
+def _set_slack_token_credentials(cred_obj, token):
+    cred_obj.SLACK_TOKEN = token

notipyer/email_notify.py

@@ -1,11 +1,12 @@
-from .credential_handler import credentials, _set_email_credentials
-from .errors import GmailLoginException, RecipientNotPresentException
-from .async_decorator import Async
+from .credential_handler import _set_email_credentials
+from .utils.errors import GmailLoginException, RecipientNotPresentException
+from .utils.async_decorator import Async
+from notipyer import _get_creds
 import smtplib
 
 SMTP_GMAIL_URL = 'smtp.gmail.com'
 
-mail_cred = credentials()
+mail_cred = _get_creds()
 
 
 def _check_valid_string(string):

notipyer/errors.py

@@ -0,0 +1,32 @@
+from .credential_handler import _set_slack_token_credentials
+from .utils.async_decorator import Async
+from .utils.errors import SlackApiException
+from slack import WebClient
+from slack.errors import SlackApiError
+from notipyer import _get_creds
+
+slack_creds = _get_creds()
+slack_client = None
+
+
+def set_slack_token_config(slack_token):
+    global slack_creds
+    _set_slack_token_credentials(slack_creds, slack_token)
+
+
+def _get_slack_client():
+    global slack_creds, slack_client
+    if slack_client is None:
+        slack_client = WebClient(token=slack_creds.SLACK_TOKEN)
+    return slack_client
+
+
+@Async
+def send_message(channel, text):
+    try:
+        _get_slack_client().chat_postMessage(
+            channel=channel,
+            text=text
+        )
+    except SlackApiError as e:
+        raise SlackApiException(e)