Updates for config file parsing

Author: joergschultzelutter

.gitignore

@@ -5,3 +5,4 @@ output.xml
 report.html
 credentials
 testme.py
+__pycache__

README.md

@@ -1,5 +1,5 @@
 # robotframework-apprise
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 ```robotframework-apprise``` is a [Robot Framework](https://www.robotframework.org) keyword collection for the [Apprise](https://github.com/caronc/apprise) push message library. It enables Robot Framework users to send push/email messages to every message service supported by Apprise.
 
@@ -28,12 +28,15 @@ In order to run the example code, you need to provide at least one valid target
 |``Set Delimiter``|Optional reconfiguration of this Robot Framework library's delimiter. See details below|
 |``Set Notify Type``|Sets one of Apprise's [supported notify types](https://github.com/caronc/apprise/wiki/Development_API#message-types-and-themes). Valid values are ``info``,``success``,``warning``, and ``failure``. Default notify type is ``info``|
 |``Set Body Format``|Sets one of Apprise's [supported body formats](https://github.com/caronc/apprise/wiki/Development_API#notify--send-notifications). Valid values are ``html``,``text``, and ``markdown``. Default body format is ``html``|
+|``Set Config File``|Allows you to specify a single Apprise [config file](https://github.com/caronc/apprise#configuration-files) in YAML or Text format |
 
 
 All ``clients`` and ``attachments`` options can be passed as a ``List`` type variable or as a ``string``. If you use a ``string``, the default delimiter is a comma ``,``. In case you need to use a different delimiter for your string, use the ``Set Delimiter`` keyword.
 
 All ``Set ...`` keywords provide corresponding ``Get ...`` keywords.
 
+If you specify ``Client`` settings additionally to a ``Config File``, the library will honor both settings.
+
 ``Attachments`` are purely optional. Providing at least one ``Client`` is mandatory, though. Both ``Attachments`` and ``Clients`` can either be provided as a ``List`` item or as a separated string.
 
 Examples:
@@ -55,7 +58,14 @@ Set Delimiter            ^
 Send Apprise Message    title=Robot Framework Apprise Demo   body=Connect to Apprise with your Robot Framework Tests!    clients=<apprise_client>     attachments=http://www.mysite.com/image1.jpg^http://www.mysite.com/image2.jpg
 ```
 
+```robot
+# Send a message with one client and a List which contains our images
+@{IMAGE_LIST}=          Create List     http://www.mysite.com/image1.jpg    http://www.mysite.com/image2.jpg
+${CONFIG_FILE}          config.yaml
+Send Apprise Message    title=Robot Framework Apprise Demo   body=Connect to Apprise with your Robot Framework Tests!    config_file=${CONFIG_FILE}     attachments=${IMAGE_LIST}
+```
+
+
 ## Known issues
 
-- This library uses Apprise's default async behavior. Currently, you cannot send messages in a synchronous way.
-- The current version of this library does not support Apprise's whole feature set. Options such as tagging are not implemented.
+- The current version of this library does not support Apprise's whole feature set. Options such as tagging are not implemented (but may work if you use a [config file](https://github.com/caronc/apprise#configuration-files)-based setting)

src/AppriseLibrary.py

@@ -32,7 +32,7 @@
 )
 logger = logging.getLogger(__name__)
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 __author__ = "Joerg Schultze-Lutter"
 
 
@@ -393,8 +393,12 @@ def send_apprise_message(
 
         # Now check if we need to create the Apprise config object
         if self.config_file and self.config_file != "":
+            # Does the file exist?
             if os.path.isfile(self.config_file):
-                _apprise_config = self.apprise_instance.AppriseConfig()
+                # File exists; create the config object and then
+                # add the config file to the config object
+                _apprise_config = apprise.AppriseConfig()
+                _apprise_config.add(self.config_file)
             else:
                 logger.debug(
                     msg=f"Config file '{self.config_file}' does not exist; ignoring config file reference"
@@ -422,11 +426,13 @@ def send_apprise_message(
             self.body_format = self.__transform_body_format(body_format=body_format)
 
         # Check if we have received at least one client
-        if len(self.clients) < 1 and not apprise_config:
-            raise ValueError("You need to specify at least one target client")
+        if (self.clients and len(self.clients) < 1) and not _apprise_config:
+            raise ValueError(
+                "You need to specify at least one target client or an Apprise config file"
+            )
 
-        # Attach the clients
-        # If we have no config file, then add the clients directly
+        # Process our single client URLs
+        # If we have no config file/object , add the clients directly to Apprise
         # otherwise, add the config data to the config object and
         # later on add the config object to Apprise
         for client in self.clients:

src/config.yaml

@@ -0,0 +1,6 @@
+version: 1
+
+urls:
+  # One-liner (no colon at the end); just the url as you'd expect it:
+  - tgram://MY_CREDENTIALS_GO_HERE
+

src/send_apprise_message.robot

@@ -8,7 +8,9 @@ Library			  AppriseLibrary.py
 *** Variables ***
 @{IMAGE_LIST}     https://miro.medium.com/max/553/1*wnMQPTmEsIq0TiRgfX4hig.png   https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png
 ${CLIENT}         CONFIGURE_THIS_SETTING_WITH_AT_LEAST_ONE_VALID_APPRISE_ACCOUNT
+${CONFIG_FILE}    config.yaml
 
 *** Test Cases ***
 Send Message Through Apprise
         Send Apprise Message    title=Robot Framework Apprise Demo   body=Connect to Apprise with your Robot Framework Tests!    clients=${CLIENT}     attachments=${IMAGE_LIST}
+        Send Apprise Message    title=Robot Framework Apprise Demo   body=Connect to Apprise with your Robot Framework Tests!    config_file=${CONFIG_FILE}     attachments=${IMAGE_LIST}