Package: robotframework-apprise
robotframework-appriserobotframework-appriseis aRobot Frameworkkeyword collection for theApprisepush message library. It enables Robot Framework users to send push/email messages to every message service supported by Apprise.InstallationThe easiest way is to install this package is from pypi:pip install robotframework-appriseRobot Framework Library ExampleIn order to run the example code, you need to provide at least one valid target messenger. Have a look atApprise's list of supported messenger platformssend_apprise_message.robotLibrary usage and supported keywordsKeywordDescriptionSend Apprise MessageSends a push message through AppriseSet ClientsandSet AttachmentsSets a new value list and replace the previous valuesAdd ClientandAdd AttachmentAdds a value to an existing listRemove ClientandRemove AttachmentRemoves a value from an existing list (if present). Trying to remove a non-existing entry will NOT result in an errorClear All ClientsandClear All AttachmentsCompletely removes the current values from the respective listSet Attachment DelimiterOptional delimiter reconfiguration - see details belowSet Notify TypeSets one of Apprise'ssupported notify types. Valid values areinfo,success,warning, andfailure. Default notify type isinfoSet Body FormatSets one of Apprise'ssupported body formats. Valid values arehtml,text, andmarkdown. Default body format ishtmlSet Config FileAllows you to specify a single Appriseconfig filein YAML or Text formatBothclientsandattachmentsoptions can be passed as aListtype variableoras astring. If you use astring, the default delimiter is a comma,. Use theSet Attachment Delimiterkeyword in case you need to use a different delimiter for your attachments.AllSet ...keywords provide correspondingGet ...keywords.Attachmentsare purely optional. Providing at least oneClientis mandatory, though.Examples:# 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
Send Apprise Message    title=Robot Framework Apprise Demo   body=Connect to Apprise with your Robot Framework Tests!    clients=<apprise_client>     attachments=${IMAGE_LIST}# Send a message with one client. Our attachments use a comma-separated string (default)
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# Send a message with one client. Our attachments use a custom delimiter ^
Set Attachment 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# 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
Set Test Variable       ${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 issuesThe 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 aconfig file-based setting)Unlike the original Apprise API, only one YAML config file is currently supported with this Robot Framework keyword library.