Merge pull request #298 from Der-Henning/dev

bump version 1.16.0

Author: Der-Henning

DOCKER_README.md

@@ -10,8 +10,8 @@ Readme, source, and documentation on [https://github.com/Der-Henning/tgtg](https
 
 - [`edge`](https://github.com/Der-Henning/tgtg/blob/main/Dockerfile)
 - [`edge-alpine`](https://github.com/Der-Henning/tgtg/blob/main/Dockerfile.alpine)
-- [`v1`, `v1.15`, `v1.15.2`, `latest`](https://github.com/Der-Henning/tgtg/blob/v1.15.2/Dockerfile)
-- [`v1-alpine`, `v1.15-alpine`, `v1.15.2-alpine`, `latest-alpine`](https://github.com/Der-Henning/tgtg/blob/v1.15.2/Dockerfile.alpine)
+- [`v1`, `v1.16`, `v1.16.0`, `latest`](https://github.com/Der-Henning/tgtg/blob/v1.16.0/Dockerfile)
+- [`v1-alpine`, `v1.16-alpine`, `v1.16.0-alpine`, `latest-alpine`](https://github.com/Der-Henning/tgtg/blob/v1.16.0/Dockerfile.alpine)
 
 # Quick Start
 

README.md

@@ -169,6 +169,7 @@ pip install -r requirements-dev.txt
 - `make bash` starts dev python docker image with installed dependencies and mounted project in bash
 - `make executable` creates a bundled executable in `/dist`
 - `make test` runs unit tests
+- `make lint` run pre-commit hooks
 - `make clean` cleans up docker-compose
 
 ### Creating new notifiers

src/_version.py

@@ -1,6 +1,6 @@
 __title__ = "TGTG Scanner"
 __description__ = "Provides notifications for TGTG magic bags"
-__version__ = "1.15.2"
+__version__ = "1.16.0"
 __author__ = "Henning Merklinger"
 __author_email__ = "[email protected]"
 __license__ = "GPL"

src/notifiers/apprise.py

@@ -39,12 +39,13 @@ def _send(self, item: Item) -> None:
         body = item.unmask(self.body)
 
         log.debug("Apprise url: %s", url)
-        log.debug("Apprise Title: %s", title)
-        log.debug("Apprise Body: %s", body)
+        log.debug("Apprise title: %s", title)
+        log.debug("Apprise body: %s", body)
 
         apobj = apprise.Apprise()
         apobj.add(self.url)
         apobj.notify(title=title, body=body)
+        apobj.clear()
 
     def __repr__(self) -> str:
-        return f"Apprise {self.url}"
+        return f"Apprise: {self.url}"

src/notifiers/base.py

@@ -12,9 +12,13 @@ def __init__(self, config: Config):
         self.enabled = False
         self.cron = Cron()
 
+    @property
+    def name(self):
+        return self.__class__.__name__
+
     def send(self, item: Item) -> None:
         if self.enabled and self.cron.is_now:
-            log.debug("Sending %s Notification", self.__class__.__name__)
+            log.debug("Sending %s Notification", self.name)
             self._send(item)
 
     @abstractmethod

src/notifiers/ntfy.py

@@ -10,7 +10,7 @@
 
 
 class Ntfy(WebHook):
-    """Notifier for ntfy"""
+    """Notifier for Ntfy"""
 
     def __init__(self, config: Config):
         self.enabled = config.ntfy.get("enabled", False)
@@ -36,13 +36,13 @@ def __init__(self, config: Config):
             if not self.server or not self.topic:
                 raise NtfyConfigurationError()
             self.url = f"{self.server}/{self.topic}"
-            log.debug("ntfy url: %s", self.url)
+            log.debug("Ntfy url: %s", self.url)
             if (self.username and self.password) is not None:
                 self.auth = HTTPBasicAuth(self.username, self.password)
-                log.debug("Using basic auth with user '%s' for ntfy",
+                log.debug("Using basic auth with user '%s' for Ntfy",
                           self.username)
-            else:
-                log.warning("Username or Password missing for ntfy "
+            elif (self.username or self.password) is not None:
+                log.warning("Username or Password missing for Ntfy "
                             "authentication, defaulting to no auth")
             try:
                 Item.check_mask(self.title)
@@ -53,7 +53,7 @@ def __init__(self, config: Config):
                 raise NtfyConfigurationError(exc.message) from exc
 
     def _send(self, item: Item) -> None:
-        """Sends item information via configured ntfy endpoint"""
+        """Sends item information via configured Ntfy endpoint"""
         title = item.unmask(self.title).encode("utf-8")
         message = item.unmask(self.message).encode("utf-8")
         tags = item.unmask(self.tags).encode("utf-8")
@@ -68,4 +68,4 @@ def _send(self, item: Item) -> None:
         super()._send(item)
 
     def __repr__(self) -> str:
-        return f"ntfy: {self.server}/{self.topic}"
+        return f"Ntfy: {self.server}/{self.topic}"

src/notifiers/telegram.py

@@ -120,7 +120,7 @@ def _unmute(self, update: Update, context: CallbackContext) -> None:
 
     def _error(self, update: Update, context: CallbackContext) -> None:
         """Log Errors caused by Updates."""
-        log.warning('Update "%s" caused error "%s"', update, context.error)
+        log.debug('Update "%s" caused error "%s"', update, context.error)
 
     def _get_chat_id(self) -> None:
         """Initializes an interaction with the user

src/notifiers/webhook.py

@@ -42,7 +42,7 @@ def __init__(self, config: Config):
     def _send(self, item: Item) -> None:
         """Sends item information via configured Webhook endpoint"""
         url = item.unmask(self.url)
-        log.debug("%s url: %s", self.__class__.__name__, url)
+        log.debug("%s url: %s", self.name, url)
         body = None
         headers = self.headers
         if self.type:
@@ -53,15 +53,15 @@ def _send(self, item: Item) -> None:
                 body = json.dumps(json.loads(body.replace('\n', '\\n')))
             else:
                 body = body.encode('utf-8')
-            log.debug("%s body: '%s'", self.__class__.__name__, body)
-        log.debug("%s headers: %s", self.__class__.__name__, headers)
+            log.debug("%s body: %s", self.name, body)
+        log.debug("%s headers: %s", self.name, headers)
         res = requests.request(method=self.method, url=url,
                                timeout=self.timeout, data=body,
                                headers=headers, auth=self.auth)
         if not res.ok:
             log.error("%s Request failed with status code %s",
-                      self.__class__.__name__, res.status_code)
-            log.debug("Response content: %s", res.text)
+                      self.name, res.status_code)
+            log.debug("%s Response content: %s", self.name, res.text)
 
     def __repr__(self) -> str:
         return f"WebHook: {self.url}"