slackpy 3.0.0__py3-none-any.whl

slackpy/__init__.py

@@ -0,0 +1,3 @@
+__author__ = 'Takahiro Ikeuchi'
+
+from .slackpy import SlackLogger, LogLv, LOG_LEVELS

slackpy/commandline.py

@@ -0,0 +1,77 @@
+import os
+from slackpy import SlackLogger, LogLv, LOG_LEVELS
+from argparse import ArgumentParser
+
+__author__ = 'Takahiro Ikeuchi'
+
+
+def main():
+    parser = ArgumentParser(description='slackpy command line tool')
+    parser.add_argument('-m',
+                        '--message',
+                        type=str,
+                        required=True,
+                        help='Message body.')
+    parser.add_argument('-c',
+                        '--channel',
+                        required=False,
+                        help='Slack Channel. channel must be started with # or @',
+                        default=None)
+    parser.add_argument('-t',
+                        '--title',
+                        type=str,
+                        required=False,
+                        help='Message title.',
+                        default='Slack Notification')
+    parser.add_argument('-n',
+                        '--name',
+                        type=str,
+                        required=False,
+                        help='Your bot\'s user name',
+                        default='Logger')
+
+    # The purpose of backward compatibility, old args (1, 2, 3)
+    # are being retained.
+    # DEBUG == 10, INFO == 20, # WARNING == 30, ERROR == 40
+    parser.add_argument('-l',
+                        '--level',
+                        type=int,
+                        default=20,
+                        choices=LOG_LEVELS + [1, 2, 3])
+
+    args = parser.parse_args()
+    args.level = {1: LogLv.INFO, 2: LogLv.WARN, 3: LogLv.ERROR}.get(args.level, args.level)
+
+    try:
+        web_hook_url = os.environ["SLACK_INCOMING_WEB_HOOK"]
+
+    except KeyError:
+        print('ERROR: Please set a SLACK_INCOMING_WEB_HOOK variable in ' +
+              'your environment.')
+    else:
+
+        client = SlackLogger(web_hook_url, args.channel, args.name)
+
+        # Command Line mode can use only DEBUG level.
+        client.set_log_level(LogLv.DEBUG)
+
+        if args.level == LogLv.DEBUG:
+            response = client.debug(args.message, args.title)
+
+        elif args.level == LogLv.INFO:
+            response = client.info(args.message, args.title)
+
+        elif args.level == LogLv.WARN:
+            response = client.warn(args.message, args.title)
+
+        elif args.level == LogLv.ERROR:
+            response = client.error(args.message, args.title)
+
+        else:
+            raise Exception("'Level' must be selected from among 10 to 40")
+
+        if response.status_code == 200:
+            print(True)
+
+        else:
+            print(False)

slackpy/slackpy.py

@@ -0,0 +1,154 @@
+import json
+import traceback
+import requests
+from enum import IntEnum, unique
+from retrying import retry
+
+__author__ = 'Takahiro Ikeuchi'
+
+MULTIPLIER = 1000
+MAX_DELAY = 30000
+EXPONENTIAL_MAX = 8000
+
+
+@unique
+class LogLv(IntEnum):
+    DEBUG = 10
+    INFO = 20
+    WARN = 30
+    ERROR = 40
+
+
+LOG_LEVELS = list(map(int, LogLv))
+
+
+class SlackLogger:
+    def __init__(self, web_hook_url, channel=None, username='Logger', icon_url=None):
+
+        self.web_hook_url = web_hook_url
+        self.username = username
+        self.icon_url = icon_url
+        self.log_level = LogLv.INFO
+
+        if channel is None:
+            self.channel = None
+
+        elif channel.startswith('#') or channel.startswith('@'):
+            self.channel = channel
+
+        else:
+            raise ValueError('channel must be started with "#" or "@".')
+
+    def set_log_level(self, lv):
+
+        if lv in LOG_LEVELS:
+            self.log_level = lv
+
+        else:
+            raise ValueError('argument lv is invalid. Choose from values in ErrorLv Class.')
+
+    def __build_payload(self, message, title, title_link, color, fields):
+
+        __attachments = [{
+            'title': title,
+            'title_link': title_link,
+            'color': color,
+            'text': message,
+            'fields': fields,
+            'mrkdwn_in': ['text', 'fields', 'title']
+        }]
+
+        payload = {
+            'channel': self.channel,
+            'username': self.username,
+            'icon_url': self.icon_url,
+            'attachments': __attachments,
+        }
+
+        return payload
+
+    @retry(wait_exponential_multiplier=MULTIPLIER, stop_max_delay=MAX_DELAY, wait_exponential_max=EXPONENTIAL_MAX)
+    def __post(self, payload):
+        try:
+            response = requests.post(self.web_hook_url,
+                                     data=json.dumps(payload), timeout=3, allow_redirects=False)
+
+        except Exception:
+            raise Exception(traceback.format_exc())
+
+        else:
+            if response.status_code == 200:
+                return response
+
+            else:
+                raise Exception('failed to post a message to Slack.')
+
+    def __send_notification(self, message, title, title_link='', color='good',
+                            fields='', log_level=LogLv.INFO):
+        """Send a message to a channel.
+        Args:
+            title: Message title.
+            title_link: Link of the message title.
+            message: Message body.
+            color: Message line color on Slack. This parameter should be one of the following values: 'good', 'warning',
+             'danger' or any hex color code.
+
+        Returns:
+            response: Response of Slack API.
+
+        Raises:
+            Exception:
+        """
+        if log_level < self.log_level:
+            return None
+
+        payload = self.__build_payload(message, title, title_link, color, fields)
+
+        try:
+            response = self.__post(payload)
+
+        except Exception:
+            raise Exception(traceback.format_exc())
+
+        return response
+
+    def debug(self, message, title='Slack Notification', title_link='', fields=''):
+        return self.__send_notification(message=message,
+                                        title=title,
+                                        title_link=title_link,
+                                        color='#03A9F4',
+                                        fields=fields,
+                                        log_level=LogLv.DEBUG)
+
+    def info(self, message, title='Slack Notification', title_link='', fields=''):
+        return self.__send_notification(message=message,
+                                        title=title,
+                                        title_link=title_link,
+                                        color='good',
+                                        fields=fields,
+                                        log_level=LogLv.INFO)
+
+    def warn(self, message, title='Slack Notification', title_link='', fields=''):
+        return self.__send_notification(message=message,
+                                        title=title,
+                                        title_link=title_link,
+                                        color='warning',
+                                        fields=fields,
+                                        log_level=LogLv.WARN)
+
+    def error(self, message, title='Slack Notification', title_link='', fields=''):
+        return self.__send_notification(message=message,
+                                        title=title,
+                                        title_link=title_link,
+                                        color='danger',
+                                        fields=fields,
+                                        log_level=LogLv.ERROR)
+
+    def message(self, message, title='Slack Notification', title_link='', color='good', fields='',
+                log_level=LogLv.ERROR):
+        return self.__send_notification(message=message,
+                                        title=title,
+                                        title_link=title_link,
+                                        color=color,
+                                        fields=fields,
+                                        log_level=log_level)

slackpy-3.0.0.dist-info/METADATA

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: slackpy
+Version: 3.0.0
+Summary: A Simple and Human Friendly Slack Client for Logging.
+Author-email: Takahiro Ikeuchi <takahiro.ikeuchi@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/iktakahiro/slackpy
+Keywords: Slack,Slack Client
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: Communications :: Chat
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: requests>=2.32.5
+Requires-Dist: certifi>=2026.10.19
+Requires-Dist: retrying
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+.. image:: https://img.shields.io/pypi/v/slackpy.svg
+    :target: https://pypi.python.org/pypi/slackpy
+
+.. image:: https://img.shields.io/pypi/dm/slackpy.svg
+    :target: https://pypi.python.org/pypi/slackpy
+
+slackpy
+=======
+
+A Simple and Human Friendly `Slack`_ Client for Logging.
+
+Use Case
+--------
+
+- Web Application
+- NEW! `AWS Lambda`_
+- Bash Script
+
+Install
+-------
+
+Requires Python 3.11 or newer.
+
+.. code:: sh
+
+    pip install slackpy
+
+Dependencies
+------------
+
+- requests>=2.32.5
+- certifi>=2026.10.19
+- retrying
+
+Sample Code
+-----------
+
+.. code:: python
+
+    import slackpy
+
+    INCOMING_WEB_HOOK = 'your_web_hook_url'
+    CHANNEL = '#general'
+    USER_NAME = 'Logger'
+    ICON_URL = 'http://lorempixel.com/48/48'
+
+    # Create a new instance.
+    logging = slackpy.SlackLogger(INCOMING_WEB_HOOK, CHANNEL, USER_NAME, ICON_URL)
+
+    # You can set a log level. The default level is INFO.
+    logging.set_log_level(slackpy.LogLv.DEBUG) # Or logging.set_log_level(10)
+
+    ## Minimum Parameter
+    ## logging = slackpy.SlackLogger(INCOMING_WEB_HOOK)
+
+    # Simple Usage
+    logging.info('INFO Message')
+
+    # LogLevel's only required parameter is "message", all others are optional.
+
+    # LogLevel: DEBUG
+    logging.debug(message='DEBUG Message', title='DEBUG Title', fields='')
+
+    # LogLevel: INFO
+    logging.info(message='INFO Message', title='INFO Title', fields='')
+
+    # LogLevel: WARN
+    logging.warn(message='WARN Message', title='WARN Title', fields='')
+
+    # LogLevel: ERROR
+    logging.error(message='ERROR Message', title='ERROR Title', fields='')
+
+    # LogLevel: CUSTOM
+    logging.message(message='CUSTOM Message', title='CUSTOM Title', color='good',
+                    fields=[{"title": "CUSTOM", "value": "test", "short": True}],
+                    log_level=40)
+
+    # Title Link (New v2.1.0)
+    logging.info(message='INFO Message', title='slackpy Repository here',
+                 title_link='https://github.com/iktakahiro/slackpy')
+
+
++-----------+----------------+------------------------+
+| Method    | LogLevel       | Color                  |
++===========+================+========================+
+| debug()   | DEBUG (10)     | #03A9F4 (Light Blue)   |
++-----------+----------------+------------------------+
+| info()    | INFO (20)      | good (green)           |
++-----------+----------------+------------------------+
+| warn()    | WARNING (30)   | warning (orange)       |
++-----------+----------------+------------------------+
+| error()   | ERROR (40)     | danger (red)           |
++-----------+----------------+------------------------+
+
+The definition of the log level is based on the standard library.
+(https://docs.python.org/3/library/logging.html#levels)
+
+Command line
+------------
+
+.. code:: sh
+
+    export SLACK_INCOMING_WEB_HOOK='your_web_hook_url'
+
+    # LogLevel: DEBUG
+    slackpy -c '#your_channel' -m 'DEBUG Message' -l 10
+
+    # LogLevel: INFO
+    slackpy -c '#your_channel' -m 'INFO Message' -l 20
+
+    # LogLevel: WARN
+    slackpy -c '#your_channel' -m 'WARN Message' -l 30
+
+    # LogLevel: ERROR
+    slackpy -c '#your_channel' -m 'ERROR Message' -l 40
+
+    # LogLevel: DEBUG (without specifying #channel)
+    slackpy -m 'DEBUG Message' -l 10
+
+    # LogLevel: INFO (with Message Title)
+    slackpy -c '#your_channel' -t 'INFO Message Title' -m 'INFO Message' -l 20
+
+For AWS Lamdba
+--------------
+
+.. code:: sh
+
+   # First, pip install to top of project directory.
+   pip install slackpy -t .
+
+   # Second, archive your source code and dependency packages.
+   zip -r src.zip lambda_function.py slackpy requests certifi charset_normalizer idna urllib3 retrying
+
+   # Finally, upload src.zip
+
+About Versioning
+----------------
+
+slackpy is following `Semantic Versioning 2.0.0 <http://semver.org/spec/v2.0.0.html>`_.
+
+.. _Slack: https://slack.com
+
+.. _AWS Lambda: https://aws.amazon.com/lambda/
+

slackpy-3.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+slackpy/__init__.py,sha256=_ET2CF_zFVk5sEJx9RlVCLIgORcf0juBfjBpcB0vt6c,85
+slackpy/commandline.py,sha256=c39p_-Qd0pmahY_hiEn9x5jQDnB44yjFhpDP06aUHMg,2548
+slackpy/slackpy.py,sha256=7MH8VzIp4IULOgEmzXNu3jkR2fTjoE9irc9coIPSWZU,5245
+slackpy-3.0.0.dist-info/licenses/LICENSE,sha256=dE-ncbTW9uBwH_G0BJ1ha9ZwBb-7yv5OnoXvvqFxAzk,1089
+slackpy-3.0.0.dist-info/METADATA,sha256=_f2uLDZZPORFjFuhOlYfx4q6eYYNByfySXB0BFvIni0,4745
+slackpy-3.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+slackpy-3.0.0.dist-info/entry_points.txt,sha256=B95JRYKS-RykfC8QVrDnNydg2-iScNHhtNiYm70MV88,53
+slackpy-3.0.0.dist-info/top_level.txt,sha256=b3AeS6VqtNIKFc3V_sMWsewz0r40qQADmaDZE2-JlXU,8
+slackpy-3.0.0.dist-info/RECORD,,

slackpy-3.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

slackpy-3.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+slackpy = slackpy.commandline:main

slackpy-3.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2017 Takahiro Ikeuchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

slackpy-3.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+slackpy