Add slack contrib package for chat notifications.

docs/contrib/index.rst

@@ -27,6 +27,7 @@ To use on of the following packages in your code, you must import them explicitl
    mercurial
    numpy
    root
+   slack
    tasks
    tensorflow
    wlcg

docs/contrib/slack.rst

@@ -0,0 +1,13 @@
+slack
+=====
+
+.. automodule:: law.contrib.slack
+
+.. contents::
+
+
+Class ``NotifySlackParameter``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: NotifySlackParameter
+   :members:

law/config.py

@@ -99,6 +99,9 @@ class Config(ConfigParser):
             "mail_sender": "",
             "mail_smtp_host": "127.0.0.1",
             "mail_smtp_port": 25,
+            # contrib
+            "slack_token": "",
+            "slack_channel": "",
         },
     }
 

law/contrib/slack/__init__.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+# flake8: noqa
+
+"""
+Slack contrib functionality.
+"""
+
+
+__all__ = ["NotifySlackParameter"]
+
+
+# provisioning imports
+from law.contrib.slack.parameter import NotifySlackParameter

law/contrib/slack/parameter.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+
+"""
+Slack notification.
+"""
+
+
+from law.config import Config
+from law.parameter import NotifyParameter
+
+
+class NotifySlackParameter(NotifyParameter):
+
+    @staticmethod
+    def notify(title, parts, token=None, channel=None, **kwargs):
+        import slackclient
+
+        cfg = Config.instance()
+
+        if not token:
+            token = cfg.get("notifications", "slack_token")
+        if not channel:
+            channel = cfg.get("notifications", "slack_channel")
+
+        if token and channel:
+            # minimal markup
+            text = "*{}*\n\n".format(title)
+            for key, value in parts:
+                text += "_{}_: {}\n".format(key, value)
+
+            sc = slackclient.SlackClient(token)
+            sc.api_call(
+                "chat.postMessage",
+                channel=channel,
+                text=text,
+            )
+
+    def get_transport(self):
+        return {
+            "func": self.notify,
+            "raw": True,
+        }

setup.py

@@ -96,6 +96,7 @@ def run(self):
         "law.contrib.mercurial",
         "law.contrib.numpy",
         "law.contrib.root",
+        "law.contrib.slack",
         "law.contrib.tasks",
         "law.contrib.tensorflow",
         "law.contrib.wlcg",