ix-notifiers 0.5.2__tar.gz → 0.5.3__tar.gz

{ix_notifiers-0.5.2 → ix_notifiers-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ix-notifiers
-Version: 0.5.2
+Version: 0.5.3
 Summary: A python library for notifiers
 Author-email: Alex Thomae <notifiers@egos.tech>
 License: MIT License
@@ -33,6 +33,7 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests==2.32.3
+Requires-Dist: egos-helpers==0.5.0
 
 # ix-notifiers
 

ix_notifiers-0.5.3/ix_notifiers/__init__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+""" __init__ """
+
+from .core import register, IxNotifiers

{ix_notifiers-0.5.2 → ix_notifiers-0.5.3}/ix_notifiers/constants.py

@@ -3,6 +3,6 @@
 """ Constants declarations """
 
 # These get overwritten at build time. See build.sh
-VERSION = '0.5.2'
+VERSION = '0.5.3'
 BUILD = None
 NAME = 'ix-notifiers'

ix_notifiers-0.5.3/ix_notifiers/core.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+""" notification core """
+
+import logging
+import importlib
+from os import listdir
+from os.path import dirname, realpath
+from typing import Dict, List, Any
+from .constants import NAME
+
+log = logging.getLogger(NAME)
+
+class IxNotifiers:
+    """ the IxNotifiers class """
+
+    notifiers: List[str] = []
+    registered: Dict[str, Any] = {}
+
+    def __init__(self):
+        """
+        Records the existing notifiers
+
+        It looks in the current library directory for all files called `*_notifier.py`
+        """
+        for notifier in listdir(dirname(realpath(__file__))):
+
+            if notifier.endswith('_notifier.py'):
+                self.notifiers.append(notifier.replace('_notifier.py', ''))
+                log.debug(f"Notifier available: {notifier}")
+
+    def register(self, notifier: str, **kwargs) -> None:
+        """ registers the notifiers
+
+            Each notifier will expect `notifier_key: value`. The `notifier_` part will
+            be stripped and the notifier will get `key` set as part of `kwargs`.
+
+            For example, if the `register` `kwargs` is set to:
+
+            kwargs = {
+                'gotify_port': 1234,
+                'gotify_token': 'abc'
+            }
+
+            Then the Gotify notifier will be called with:
+
+            `gotify_notifier.start(port=1234, token='abc')`
+        """
+        log.debug(f'Registering {notifier}')
+        for n in self.notifiers:
+            if n == notifier:
+                instance = importlib.import_module(f'ix_notifiers.{notifier}_notifier')
+                # Strips the prefix from kwargs, if set
+                settings = {}
+                for k, v in kwargs.items():
+                    settings.update({k.replace(f'{notifier}_', ''): v})
+                self.registered.update({notifier: instance.start(**settings)})
+                log.debug(f'Registered {notifier}')
+
+    def notify(self, **kwargs) -> bool:
+        """
+        dispatches a notification to all the registered notifiers
+
+        param: kwargs get passed to the `send()` method of the notifier
+        return: True if at least one notification channel was successful, False otherwise
+        """
+        success = False
+        for notifier in self.registered.items():
+            log.debug(f'Sending notification to {notifier}')
+            if self.registered[notifier].send(**kwargs) is True:
+                success = True
+        return success
+
+register = IxNotifiers.register

{ix_notifiers-0.5.2 → ix_notifiers-0.5.3}/ix_notifiers/gotify_notifier.py

@@ -2,17 +2,9 @@
 # -*- coding: utf-8 -*-
 """ Gotify """
 
-import logging
 from urllib.parse import urljoin
 import requests
-from .core import Notifier
-from .constants import NAME, BUILD, VERSION
-
-log = logging.getLogger(NAME)
-
-def start(**kwargs):
-    """ Returns an instance of the GotifyNotifier """
-    return GotifyNotifier(**kwargs)
+from .notifier import Notifier, log
 
 class GotifyNotifier(Notifier):
     """ The GotifyNotifier class """
@@ -52,7 +44,7 @@ class GotifyNotifier(Notifier):
         success = True
         headers = {
             'X-Gotify-Key': self.settings['token'],
-            'user-agent': f'{__package__} {VERSION}.{BUILD}',
+            'user-agent': f'{self.user_agent}',
         }
         # Allow per message override of content_type
         extras = {
@@ -106,3 +98,5 @@ class GotifyNotifier(Notifier):
                 log.info("Sent message to gotify")
 
         return success
+
+start = GotifyNotifier.start

ix_notifiers-0.5.3/ix_notifiers/notifier.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+""" The Notifier Class """
+
+from typing import Dict
+from egos_helpers import redact
+from .constants import NAME, BUILD, VERSION
+from .core import log
+
+class Notifier:
+    """
+    The base class, extended by notifiers
+
+    This class not meant to be used directly!
+    """
+
+    settings: Dict = {}
+    params: Dict = {}
+
+    version: str
+    user_agent: str
+
+    def __init__(self, **kwargs):
+
+        self.version = VERSION
+        if BUILD:
+            self.version += f'.{BUILD}'
+
+        self.user_agent = f'{NAME} {self.version}'
+
+        # go through self.params and check against kwargs
+        for param, setting in self.params.items():
+            if setting.get('mandatory') and not kwargs.get(f'{param}'):
+                raise ValueError(f'{param} is mandatory')
+            self.settings[param] = kwargs.get(f'{param}', self.params[param].get('default'))
+
+            if (setting['type'] == 'boolean') and not isinstance(self.settings[param], bool):
+                raise ValueError(f'`{param}` is not bool but {type(self.settings[param])}')
+            if (setting['type'] == 'integer') and not isinstance(self.settings[param], int):
+                raise ValueError(f'`{param}` is not int but {type(self.settings[param])}')
+            if (setting['type'] == 'string') and not isinstance(self.settings[param], str):
+                raise ValueError(f'`{param}` is not str but {type(self.settings[param])}')
+
+    @classmethod
+    def start(cls, **kwargs):
+        """ Returns an instance of the Notifier """
+        return cls(**kwargs)
+
+    def send(self, **kwargs) -> bool:
+        """
+        logs the notification to info
+
+        This method must be overwritten by the notifiers
+
+        return: True
+        """
+        log.info(f"{self.redact(str(kwargs))}")
+        return True
+
+    def redact(self, message: str) -> str:
+        """ based on self.params, it replaces sensitive information in message with a redacted string """
+        for param, setting in self.params.items():
+            message = redact(message, self.settings[param], setting.get('redact', False))
+        return message

{ix_notifiers-0.5.2 → ix_notifiers-0.5.3}/ix_notifiers/null_notifier.py

@@ -2,16 +2,7 @@
 # -*- coding: utf-8 -*-
 """ Null """
 
-import logging
-from .core import Notifier
-from .constants import NAME
-
-log = logging.getLogger(NAME)
-
-def start(**kwargs):
-    """ Returns an instance of NullNotifier """
-    return NullNotifier(**kwargs)
-
+from .notifier import Notifier, log
 
 class NullNotifier(Notifier):
     """ The NullNotifier class """
@@ -20,3 +11,5 @@ class NullNotifier(Notifier):
         self.settings = {}
         super().__init__(**kwargs)
         log.debug("Initialized")
+
+start = NullNotifier.start

{ix_notifiers-0.5.2 → ix_notifiers-0.5.3}/ix_notifiers.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ix-notifiers
-Version: 0.5.2
+Version: 0.5.3
 Summary: A python library for notifiers
 Author-email: Alex Thomae <notifiers@egos.tech>
 License: MIT License
@@ -33,6 +33,7 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests==2.32.3
+Requires-Dist: egos-helpers==0.5.0
 
 # ix-notifiers
 

{ix_notifiers-0.5.2 → ix_notifiers-0.5.3}/ix_notifiers.egg-info/SOURCES.txt

@@ -7,7 +7,9 @@ ix_notifiers/__init__.py
 ix_notifiers/constants.py
 ix_notifiers/core.py
 ix_notifiers/gotify_notifier.py
+ix_notifiers/notifier.py
 ix_notifiers/null_notifier.py
+ix_notifiers/py.typed
 ix_notifiers.egg-info/PKG-INFO
 ix_notifiers.egg-info/SOURCES.txt
 ix_notifiers.egg-info/dependency_links.txt

ix_notifiers-0.5.3/ix_notifiers.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests==2.32.3
+egos-helpers==0.5.0

{ix_notifiers-0.5.2 → ix_notifiers-0.5.3}/pyproject.toml

@@ -1,6 +1,7 @@
 [build-system]
 requires = [
-    "setuptools >= 77.0.3"
+    "setuptools >= 77.0.3",
+    "egos-helpers >= 0.5.0"
 ]
 build-backend = "setuptools.build_meta"
 

ix_notifiers-0.5.3/requirements.txt

@@ -0,0 +1,2 @@
+requests==2.32.3
+egos-helpers==0.5.0

ix_notifiers-0.5.2/ix_notifiers/__init__.py

@@ -1,2 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-

ix_notifiers-0.5.2/ix_notifiers/core.py

@@ -1,90 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-""" notification core """
-
-import logging
-import importlib
-from .constants import NAME
-
-log = logging.getLogger(NAME)
-
-class IxNotifiers():
-    """ the IxNotifiers class """
-
-    notifiers = [
-        'gotify',
-        'null',
-    ]
-
-    registered = {}
-
-    def register(self, notifier, **kwargs):
-        """ registers a notifier """
-        log.debug(f'Registering {notifier}')
-        for n in self.notifiers:
-            if n == notifier:
-                instance = importlib.import_module(f'ix_notifiers.{notifier}_notifier')
-                # Strips the prefix from kwargs, if set
-                settings = {}
-                for k, v in kwargs.items():
-                    settings.update({k.replace(f'{notifier}_', ''): v})
-                self.registered.update({notifier: instance.start(**settings)})
-                log.debug(f'Registered {notifier}')
-
-    def notify(self, **kwargs) -> bool:
-        """
-        dispatches a notification to all the registered notifiers
-
-        param: kwargs get passed to the `send()` method of the notifier
-        return: True if at least one notification channel was successful, False otherwise
-        """
-        success = False
-        for notifier in self.registered.items():
-            log.debug(f'Sending notification to {notifier}')
-            if self.registered[notifier].send(**kwargs) is True:
-                success = True
-        return success
-
-class Notifier():
-    """ The base class, extended by notifiers """
-
-    settings = {}
-    params = {}
-
-    def __init__(self, **kwargs):
-        # go through self.params and check against kwargs
-        for param, setting in self.params.items():
-            if setting.get('mandatory') and not kwargs.get(f'{param}'):
-                raise ValueError(f'{param} is mandatory')
-            self.settings[param] = kwargs.get(f'{param}', self.params[param].get('default'))
-
-            if (setting['type'] == 'boolean') and not isinstance(self.settings[param], bool):
-                raise ValueError(f'`{param}` is not bool but {type(self.settings[param])}')
-            if (setting['type'] == 'integer') and not isinstance(self.settings[param], int):
-                raise ValueError(f'`{param}` is not int but {type(self.settings[param])}')
-            if (setting['type'] == 'string') and not isinstance(self.settings[param], str):
-                raise ValueError(f'`{param}` is not str but {type(self.settings[param])}')
-
-    def key_to_title(self, key: str) -> str:
-        """ converts a configuration key in form 'a_is_b' to a title in form 'A Is B ' """
-        parsed = ""
-        keys = key.split('_')
-        for k in keys:
-            parsed += f'{k.capitalize()} '
-        return parsed[:-1]
-
-    def send(self, **kwargs):
-        """
-        logs the notification to info
-
-        return: True
-        """
-        log.info(f"{self.redact(str(kwargs))}")
-        return True
-
-    def redact(self, message: str) -> str:
-        """ based on self.params, it replaces sensitive information in message with a redacted string """
-        for param, setting in self.params.items():
-            if setting.get('redact') and self.settings.get(param):
-                message = message.replace(self.settings.get(param), 'xxxREDACTEDxxx')
-        return message

ix_notifiers-0.5.2/ix_notifiers.egg-info/requires.txt

@@ -1 +0,0 @@
-requests==2.32.3

ix_notifiers-0.5.2/requirements.txt

@@ -1 +0,0 @@
-requests==2.32.3