Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joergschultzelutter/robotframework-apprise
Robot Framework keywords for the Apprise push notification library
https://github.com/joergschultzelutter/robotframework-apprise
apprise messaging push-notifications pushnotifications robot robotframework robotframework-library rpa testing
Last synced: about 1 month ago
JSON representation
Robot Framework keywords for the Apprise push notification library
- Host: GitHub
- URL: https://github.com/joergschultzelutter/robotframework-apprise
- Owner: joergschultzelutter
- License: gpl-3.0
- Created: 2022-01-28T22:30:19.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-11T09:54:13.000Z (over 1 year ago)
- Last Synced: 2024-09-18T12:52:26.477Z (about 2 months ago)
- Topics: apprise, messaging, push-notifications, pushnotifications, robot, robotframework, robotframework-library, rpa, testing
- Language: Python
- Homepage:
- Size: 129 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# robotframework-apprise
[](https://www.gnu.org/licenses/gpl-3.0) [](https://github.com/psf/black) [](https://github.com/joergschultzelutter/robotframework-apprise/actions/workflows/codeql.yml) [](https://pypi.python.org/pypi/robotframework-apprise)
```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.
## Installation
The easiest way is to install this package is from pypi:
pip install robotframework-apprise
## Robot Framework Library Example
In order to run the example code, you need to provide at least one valid target messenger. Have a look at [Apprise's list of supported messenger platforms](https://github.com/caronc/apprise/wiki)
- [send_apprise_message.robot](https://github.com/joergschultzelutter/robotframework-apprise/blob/master/test/send_apprise_message.robot)
## Library usage and supported keywords
| Keyword | Description |
|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ``Send Apprise Message`` | Sends a push message through Apprise |
| ``Set Clients`` and ``Set Attachments`` | Sets a new value list and replace the previous values |
| ``Add Client`` and ``Add Attachment`` | Adds a value to an existing list |
| ``Remove Client`` and ``Remove Attachment`` | Removes a value from an existing list (if present). Trying to remove a non-existing entry will NOT result in an error |
| ``Clear All Clients`` and ``Clear All Attachments`` | Completely removes the current values from the respective list |
| ``Set Attachment Delimiter`` | Optional delimiter reconfiguration - 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 |
Both ``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 ``,``. Use the ``Set Attachment Delimiter`` keyword in case you need to use a different delimiter for your attachments.
All ``Set ...`` keywords provide corresponding ``Get ...`` keywords.
``Attachments`` are purely optional. Providing at least one ``Client`` is mandatory, though.
Examples:
```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
Send Apprise Message title=Robot Framework Apprise Demo body=Connect to Apprise with your Robot Framework Tests! clients= attachments=${IMAGE_LIST}
```
```robot
# 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= attachments=http://www.mysite.com/image1.jpg,http://www.mysite.com/image2.jpg
```
```robot
# 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= 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
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 issues
- 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)
- Unlike the original Apprise API, only one YAML config file is currently supported with this Robot Framework keyword library.