{"id":16793566,"url":"https://github.com/joergschultzelutter/robotframework-apprise","last_synced_at":"2026-05-20T15:02:02.029Z","repository":{"id":44607689,"uuid":"453235475","full_name":"joergschultzelutter/robotframework-apprise","owner":"joergschultzelutter","description":"Robot Framework keywords for the Apprise push notification library","archived":false,"fork":false,"pushed_at":"2023-08-11T09:54:13.000Z","size":132,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-25T07:21:26.257Z","etag":null,"topics":["apprise","messaging","push-notifications","pushnotifications","robot","robotframework","robotframework-library","rpa","testing"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joergschultzelutter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-28T22:30:19.000Z","updated_at":"2023-02-17T18:09:10.000Z","dependencies_parsed_at":"2024-11-13T11:41:53.051Z","dependency_job_id":"5373f777-f096-4ae9-a33e-6ea632bae475","html_url":"https://github.com/joergschultzelutter/robotframework-apprise","commit_stats":{"total_commits":48,"total_committers":2,"mean_commits":24.0,"dds":"0.39583333333333337","last_synced_commit":"267d1afee9dcd62461badfc97ccc8a8a7b157b02"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joergschultzelutter%2Frobotframework-apprise","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joergschultzelutter%2Frobotframework-apprise/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joergschultzelutter%2Frobotframework-apprise/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joergschultzelutter%2Frobotframework-apprise/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joergschultzelutter","download_url":"https://codeload.github.com/joergschultzelutter/robotframework-apprise/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243960636,"owners_count":20375107,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apprise","messaging","push-notifications","pushnotifications","robot","robotframework","robotframework-library","rpa","testing"],"created_at":"2024-10-13T08:49:39.710Z","updated_at":"2026-05-20T15:02:01.956Z","avatar_url":"https://github.com/joergschultzelutter.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# robotframework-apprise\n[![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) [![CodeQL](https://github.com/joergschultzelutter/robotframework-apprise/actions/workflows/codeql.yml/badge.svg)](https://github.com/joergschultzelutter/robotframework-apprise/actions/workflows/codeql.yml) [![PyPi version](https://img.shields.io/pypi/v/robotframework-apprise.svg)](https://pypi.python.org/pypi/robotframework-apprise)\n\n```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.\n\n![transmit](https://github.com/joergschultzelutter/robotframework-apprise/blob/master/img/message.jpg?raw=true)\n\n## Installation\n\nThe easiest way is to install this package is from pypi:\n\n    pip install robotframework-apprise\n\n## Robot Framework Library Example\n\nIn 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)\n\n- [send_apprise_message.robot](https://github.com/joergschultzelutter/robotframework-apprise/blob/master/test/send_apprise_message.robot)\n\n## Library usage and supported keywords\n\n| Keyword                                             | Description                                                                                                                                                                                                                          |\n|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``Send Apprise Message``                            | Sends a push message through Apprise                                                                                                                                                                                                 |\n| ``Set Clients`` and ``Set Attachments``             | Sets a new value list and replace the previous values                                                                                                                                                                                |\n| ``Add Client`` and ``Add Attachment``               | Adds a value to an existing list                                                                                                                                                                                                     |\n| ``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                                                                                                                |\n| ``Clear All Clients`` and ``Clear All Attachments`` | Completely removes the current values from the respective list                                                                                                                                                                       |\n| ``Set Attachment Delimiter``                        | Optional delimiter reconfiguration - see details below                                                                                                                                                                               |\n| ``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`` |\n| ``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``             |\n| ``Set Config File``                                 | Allows you to specify a single Apprise [config file](https://github.com/caronc/apprise#configuration-files) in YAML or Text format                                                                                                   |\n\nBoth ``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.\n\nAll ``Set ...`` keywords provide corresponding ``Get ...`` keywords.\n\n``Attachments`` are purely optional. Providing at least one ``Client`` is mandatory, though.\n\nExamples:\n\n```robot\n# Send a message with one client and a List which contains our images\n@{IMAGE_LIST}=          Create List     http://www.mysite.com/image1.jpg    http://www.mysite.com/image2.jpg\nSend Apprise Message    title=Robot Framework Apprise Demo   body=Connect to Apprise with your Robot Framework Tests!    clients=\u003capprise_client\u003e     attachments=${IMAGE_LIST}\n```\n\n```robot\n# Send a message with one client. Our attachments use a comma-separated string (default)\nSend Apprise Message    title=Robot Framework Apprise Demo   body=Connect to Apprise with your Robot Framework Tests!    clients=\u003capprise_client\u003e     attachments=http://www.mysite.com/image1.jpg,http://www.mysite.com/image2.jpg\n```\n\n```robot\n# Send a message with one client. Our attachments use a custom delimiter ^\nSet Attachment Delimiter    ^\nSend Apprise Message    title=Robot Framework Apprise Demo   body=Connect to Apprise with your Robot Framework Tests!    clients=\u003capprise_client\u003e     attachments=http://www.mysite.com/image1.jpg^http://www.mysite.com/image2.jpg\n```\n\n```robot\n# Send a message with one client and a List which contains our images\n@{IMAGE_LIST}=          Create List     http://www.mysite.com/image1.jpg    http://www.mysite.com/image2.jpg\nSet Test Variable       ${CONFIG_FILE}  config.yaml\nSend Apprise Message    title=Robot Framework Apprise Demo   body=Connect to Apprise with your Robot Framework Tests!    config_file=${CONFIG_FILE}     attachments=${IMAGE_LIST}\n```\n\n## Known issues\n\n- 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)\n- Unlike the original Apprise API, only one YAML config file is currently supported with this Robot Framework keyword library.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoergschultzelutter%2Frobotframework-apprise","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoergschultzelutter%2Frobotframework-apprise","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoergschultzelutter%2Frobotframework-apprise/lists"}