## Allure Robot Framework Listener
[](https://pypi.python.org/pypi/allure-robotframework)
[](https://pypi.python.org/pypi/allure-robotframework)
> An Allure adapter for [Robot Framework](https://robotframework.org/).
[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates
- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action
---
## Installation and Usage
```shell
$ pip install allure-robotframework
$ robot --listener allure_robotframework ./my_robot_test
```
The default output directory is `output/allure`.
Use the listener's argument to change it:
```shell
$ robot --listener allure_robotframework:/set/your/path/here ./my_robot_test
```
The listener supports [the robotframework-pabot library](https://pypi.python.org/pypi/robotframework-pabot):
```shell
$ pabot --listener allure_robotframework ./my_robot_test
```
The advanced listener settings:
- ALLURE_MAX_STEP_MESSAGE_COUNT=5. If a robotframework step contains less
messages than has been specified by this setting, each message is shown as a substep.
This reduces the number of attachments in large projects. The default value
is zero - all messages are displayed as attachments.
### Usage examples
See the usage examples [here](https://github.com/allure-framework/allure-python/tree/master/allure-robotframework/examples).
## Contributing to allure-robotframework
This project exists thanks to all the people who contribute. Especially to
[Megafon](https://corp.megafon.com) and [@skhomuti](https://github.com/skhomuti)
who has initially started allure-robotframework and has been maintaining it
since then.
Raw data
{
"_id": null,
"home_page": "https://allurereport.org/",
"name": "allure-robotframework",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "allure reporting robotframework",
"author": "Sergey Khomutinin",
"author_email": "skhomuti@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/73/f2/6bef8022c4c365321ac799338b8bc00145d25261e2484065220e708cd446/allure-robotframework-2.13.5.tar.gz",
"platform": null,
"description": "## Allure Robot Framework Listener\n\n[](https://pypi.python.org/pypi/allure-robotframework)\n[](https://pypi.python.org/pypi/allure-robotframework)\n\n> An Allure adapter for [Robot Framework](https://robotframework.org/).\n\n[<img src=\"https://allurereport.org/public/img/allure-report.svg\" height=\"85px\" alt=\"Allure Report logo\" align=\"right\" />](https://allurereport.org \"Allure Report\")\n\n- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)\n- \ud83d\udcda [Documentation](https://allurereport.org/docs/) \u2013 discover official documentation for Allure Report\n- \u2753 [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) \u2013 get help from the team and community\n- \ud83d\udce2 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) \u2013 stay updated with our latest news and updates\n- \ud83d\udcac [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) \u2013 engage in casual conversations, share insights and ideas with the community\n- \ud83d\udda5\ufe0f [Live Demo](https://demo.allurereport.org/) \u2014 explore a live example of Allure Report in action\n\n---\n\n## Installation and Usage\n\n```shell\n$ pip install allure-robotframework\n$ robot --listener allure_robotframework ./my_robot_test\n```\n\nThe default output directory is `output/allure`.\nUse the listener's argument to change it:\n\n```shell\n$ robot --listener allure_robotframework:/set/your/path/here ./my_robot_test\n```\n\nThe listener supports [the robotframework-pabot library](https://pypi.python.org/pypi/robotframework-pabot):\n\n```shell\n$ pabot --listener allure_robotframework ./my_robot_test\n```\n\nThe advanced listener settings:\n\n - ALLURE_MAX_STEP_MESSAGE_COUNT=5. If a robotframework step contains less\n messages than has been specified by this setting, each message is shown as a substep.\n This reduces the number of attachments in large projects. The default value\n is zero - all messages are displayed as attachments.\n\n### Usage examples\n\nSee the usage examples [here](https://github.com/allure-framework/allure-python/tree/master/allure-robotframework/examples).\n\n## Contributing to allure-robotframework\n\nThis project exists thanks to all the people who contribute. Especially to\n[Megafon](https://corp.megafon.com) and [@skhomuti](https://github.com/skhomuti)\nwho has initially started allure-robotframework and has been maintaining it\nsince then.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Allure Robot Framework integration",
"version": "2.13.5",
"project_urls": {
"Homepage": "https://allurereport.org/",
"Source": "https://github.com/allure-framework/allure-python"
},
"split_keywords": [
"allure",
"reporting",
"robotframework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1523305b58ec7b7c4b826fc7cb3d977512371930ab6950ea22114615f5bfd6f9",
"md5": "81d761006f7a56fd865e99a1560b5668",
"sha256": "781bfcf137e2587818f1b5e388237a99b9a73bab196add192aa26f1042f7d9d2"
},
"downloads": -1,
"filename": "allure_robotframework-2.13.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81d761006f7a56fd865e99a1560b5668",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9151,
"upload_time": "2024-04-01T16:51:28",
"upload_time_iso_8601": "2024-04-01T16:51:28.663139Z",
"url": "https://files.pythonhosted.org/packages/15/23/305b58ec7b7c4b826fc7cb3d977512371930ab6950ea22114615f5bfd6f9/allure_robotframework-2.13.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "73f26bef8022c4c365321ac799338b8bc00145d25261e2484065220e708cd446",
"md5": "e7b568205f34639967286abe517fe1ff",
"sha256": "65760a19c1b8b7b8b592a91a1670054db6a656e415b559dd15f573c6d4c8f4b9"
},
"downloads": -1,
"filename": "allure-robotframework-2.13.5.tar.gz",
"has_sig": false,
"md5_digest": "e7b568205f34639967286abe517fe1ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12935,
"upload_time": "2024-04-01T16:51:29",
"upload_time_iso_8601": "2024-04-01T16:51:29.918135Z",
"url": "https://files.pythonhosted.org/packages/73/f2/6bef8022c4c365321ac799338b8bc00145d25261e2484065220e708cd446/allure-robotframework-2.13.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 16:51:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "allure-framework",
"github_project": "allure-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "allure-robotframework"
}
JSON
