Avocado Job Notification Mail Plugin
====================================
The Avocado Job Notification plugin enables you to receive email notifications for job start and completion events within the Avocado testing framework.
*Currently Only Supports Gmail*
Installation
------------
To install the Mail Results plugin from pip, use:
.. code-block:: bash
$ pip install avocado-framework-plugin-mail
Configuration
-------------
To use the Avocado Job Notification plugin, you need to configure it in the Avocado settings file
(`avocado.conf` - located at /etc/avocado/ if not present you can create the file.).
Below is an example configuration:
.. code-block:: ini
[plugins.mail]
# The email address to which job notification emails will be sent.
recipient = avocado@local.com
# The subject header for the job notification emails.
header = [AVOCADO JOB NOTIFICATION]
# The email address from which the job notification emails will be sent.
sender = avocado@local.com
# The SMTP server address for sending the emails.
server = smtp.gmail.com
# The SMTP server port for sending the emails.
port = 587
# The application-specific password for the sender email address.
password = abcd efgh ijkl mnop
# The detail level of the email content.
# Set to false for a summary with essential details or true for detailed information about each failed test.
detail_level = false
Usage
-----
Once configured, the Avocado Job Notification plugin will automatically send email notifications for job start and completion events based on the specified settings.
Obtaining an App Password for Gmail
-----------------------------------
Please follow these steps to generate an App Password:
Create & use app passwords
Important: To create an app password, you need 2-Step Verification on your Google Account.
#. Go to your Google Account.
#. Select Security.
#. Under "How you sign in to Google," select 2-Step Verification.
#. At the bottom of the page, select App passwords.
#. Enter a name that helps you remember where you’ll use the app password.
#. Select Generate.
#. To enter the app password, follow the instructions on your screen. The app password is the 16-character code that generates on your device.
#. Select Done.
Enter the App Password inside of the avocado configuration file.
Remember to keep this App Password secure and don't share it with anyone. If you suspect it has been compromised, you can always revoke it and generate a new one.
Raw data
{
"_id": null,
"home_page": "http://avocado-framework.github.io/",
"name": "avocado-framework-plugin-mail-result",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Avocado Developers",
"author_email": "avocado-devel@redhat.com",
"download_url": "https://files.pythonhosted.org/packages/f5/ed/11c016c34a11bd4b5aac3d36aaeed11ffd039e40458ac17972823d2f7533/avocado_framework_plugin_mail_result-105.0.tar.gz",
"platform": null,
"description": "Avocado Job Notification Mail Plugin\n====================================\n\nThe Avocado Job Notification plugin enables you to receive email notifications for job start and completion events within the Avocado testing framework.\n\n*Currently Only Supports Gmail*\n\nInstallation\n------------\n\nTo install the Mail Results plugin from pip, use:\n\n.. code-block:: bash\n\n $ pip install avocado-framework-plugin-mail\n\nConfiguration\n-------------\n\nTo use the Avocado Job Notification plugin, you need to configure it in the Avocado settings file\n(`avocado.conf` - located at /etc/avocado/ if not present you can create the file.).\nBelow is an example configuration:\n\n.. code-block:: ini\n\n [plugins.mail]\n\n # The email address to which job notification emails will be sent.\n recipient = avocado@local.com\n\n # The subject header for the job notification emails.\n header = [AVOCADO JOB NOTIFICATION]\n\n # The email address from which the job notification emails will be sent.\n sender = avocado@local.com\n\n # The SMTP server address for sending the emails.\n server = smtp.gmail.com\n\n # The SMTP server port for sending the emails.\n port = 587\n\n # The application-specific password for the sender email address.\n password = abcd efgh ijkl mnop\n\n # The detail level of the email content.\n # Set to false for a summary with essential details or true for detailed information about each failed test.\n detail_level = false\n\nUsage\n-----\n\nOnce configured, the Avocado Job Notification plugin will automatically send email notifications for job start and completion events based on the specified settings.\n\nObtaining an App Password for Gmail\n-----------------------------------\n\nPlease follow these steps to generate an App Password:\n\nCreate & use app passwords\n\nImportant: To create an app password, you need 2-Step Verification on your Google Account.\n\n#. Go to your Google Account.\n#. Select Security.\n#. Under \"How you sign in to Google,\" select 2-Step Verification.\n#. At the bottom of the page, select App passwords.\n#. Enter a name that helps you remember where you\u2019ll use the app password.\n#. Select Generate.\n#. To enter the app password, follow the instructions on your screen. The app password is the 16-character code that generates on your device.\n#. Select Done.\n\nEnter the App Password inside of the avocado configuration file.\n\nRemember to keep this App Password secure and don't share it with anyone. If you suspect it has been compromised, you can always revoke it and generate a new one.\n",
"bugtrack_url": null,
"license": null,
"summary": "Avocado Mail Results for Jobs",
"version": "105.0",
"project_urls": {
"Homepage": "http://avocado-framework.github.io/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa4b01debe226590cc107116229f5e1207ca4001633cd46f62e25fed8b809365",
"md5": "a2480f456ed1cd54d91ad40e994b673e",
"sha256": "5d1a846281feaee927a326475607d625c090189cc0493fe22ed4cee575572cf6"
},
"downloads": -1,
"filename": "avocado_framework_plugin_mail_result-105.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2480f456ed1cd54d91ad40e994b673e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5132,
"upload_time": "2024-06-17T15:45:13",
"upload_time_iso_8601": "2024-06-17T15:45:13.113462Z",
"url": "https://files.pythonhosted.org/packages/fa/4b/01debe226590cc107116229f5e1207ca4001633cd46f62e25fed8b809365/avocado_framework_plugin_mail_result-105.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f5ed11c016c34a11bd4b5aac3d36aaeed11ffd039e40458ac17972823d2f7533",
"md5": "967e14770c285560184c402bb60c49f2",
"sha256": "1a66287a3eee30419ebdfc8581d06b3f282eda83e9a637205be1939c6ddc1a4e"
},
"downloads": -1,
"filename": "avocado_framework_plugin_mail_result-105.0.tar.gz",
"has_sig": false,
"md5_digest": "967e14770c285560184c402bb60c49f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5129,
"upload_time": "2024-06-17T15:45:15",
"upload_time_iso_8601": "2024-06-17T15:45:15.174603Z",
"url": "https://files.pythonhosted.org/packages/f5/ed/11c016c34a11bd4b5aac3d36aaeed11ffd039e40458ac17972823d2f7533/avocado_framework_plugin_mail_result-105.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-17 15:45:15",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "avocado-framework-plugin-mail-result"
}
JSON