=================
pytest-bdd-report
=================
|python| |pypi| |formatting| |tests| |ui_tests|
|mstats| |total|
.. |total| image:: https://static.pepy.tech/badge/pytest-bdd-report
:target: https://pepy.tech/project/pytest-bdd-report
:alt: PePy total downloads
.. |pypi| image:: https://img.shields.io/pypi/v/pytest-bdd-report.svg
:target: https://pypi.org/project/pytest-bdd-report
:alt: PyPI version
.. |python| image:: https://img.shields.io/pypi/pyversions/pytest-bdd-report.svg
:target: https://pypi.org/project/pytest-bdd-report
:alt: Python versions
.. |formatting| image:: https://img.shields.io/github/actions/workflow/status/mattiamonti/pytest-bdd-report/automated%20tests.yml?logo=GitHub%20actions&label=Formatting
:alt: GitHub Workflow Status (with event)
.. |tests| image:: https://img.shields.io/github/actions/workflow/status/mattiamonti/pytest-bdd-report/automated%20tests.yml?logo=pytest&label=Tests
:alt: GitHub Workflow Status (with event)
.. |ui_tests| image:: https://img.shields.io/github/actions/workflow/status/mattiamonti/pytest-bdd-report/ui%20automated%20tests.yml?logo=robotframework&label=UI%20Tests
:alt: GitHub Workflow Status (with event)
.. |mstats| image:: https://img.shields.io/pypi/dm/pytest-bdd-report
:alt: PyPI - Downloads
.. |dstats| image:: https://img.shields.io/pypi/dd/pytest-bdd-report
:alt: PyPI - Downloads
The `pytest-bdd-report` plugin is a useful extension for the `pytest-bdd`_ library that allows you to generate
useful and informative reports for BDD (Behavior-Driven Development) tests developed using the pytest-bdd framework.
This plugin facilitates the generation of clear and effective HTML reports, providing a comprehensible view of BDD test executions within the project.
For more, check out the `Documentation`_
----
This `pytest`_ plugin was generated with `Cookiecutter`_ along with `@hackebrot`_'s `cookiecutter-pytest-plugin`_ template.
Features
--------
* **Detailed BDD Reports**: The pytest-bdd-report plugin enables the generation of detailed reports for BDD tests executed using pytest-bdd. These reports clearly show the executed steps, tested scenarios, and obtained results.
* **HTML Format**: The generated reports are presented in an intuitive and interactive HTML format. This allows developers, testers, and other team members to easily view the status of BDD tests.
* **Easy Installation**: Installing the plugin is simple and fast. You can install it using the command `pip install pytest-bdd-report`.
Requirements
------------
* Jinja2
* pytest
* pytest-bdd
Installation
------------
1. Ensure that you have `pytest`_ and `pytest-bdd`_ installed in your development environment.
2. Open a terminal window.
3. Execute the following command to install the `pytest-bdd-report` plugin via `pip`_ from `PyPI`_
::
$ pip install pytest-bdd-report
Usage
-----
Once installed, you can generate BDD reports in an HTML file using the following command:
::
$ pytest --bdd-report="report.html"
Run tests
---------
To run tests:
1. Create a virtual environment
2. Install the required packages:
::
$ pip install -r requirements.txt
3. Install the plugin locally:
::
$ pip install -e .
4. Run the unit tests:
::
$ python -m pytest
5. Run the UI tests with Robot Framework:
::
$ cd tests/ui_testing
$ ./execute_all_ui_tests.sh
Contributing
------------
Contributions are very welcome. Tests can be run with `pytest`_ as shown.
License
-------
Distributed under the terms of the `MIT`_ license, "pytest-bdd-report" is free and open source software
Issues
------
If you encounter any problems, please `file an issue`_ along with a detailed description.
.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
.. _`@hackebrot`: https://github.com/hackebrot
.. _`MIT`: http://opensource.org/licenses/MIT
.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`file an issue`: https://github.com/mattiamonti/pytest-bdd-report/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.io/en/latest/
.. _`pip`: https://pypi.org/project/pip/
.. _`PyPI`: https://pypi.org/project
.. _`pytest-bdd`: https://github.com/pytest-dev/pytest-bdd
.. _`Documentation`: https://mattia-monti.gitbook.io/pytest-bdd-report/
Raw data
{
"_id": null,
"home_page": null,
"name": "pytest-bdd-report",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Mattia Monti <mattiamonti2001@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/95/93/883bdaf32b888f620e1738bc80736924a9feb864ca0e3b7714e28f90c6ba/pytest_bdd_report-1.0.3.tar.gz",
"platform": null,
"description": "=================\npytest-bdd-report\n=================\n\n|python| |pypi| |formatting| |tests| |ui_tests|\n\n|mstats| |total|\n\n.. |total| image:: https://static.pepy.tech/badge/pytest-bdd-report\n :target: https://pepy.tech/project/pytest-bdd-report\n :alt: PePy total downloads\n\n.. |pypi| image:: https://img.shields.io/pypi/v/pytest-bdd-report.svg\n :target: https://pypi.org/project/pytest-bdd-report\n :alt: PyPI version\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/pytest-bdd-report.svg\n :target: https://pypi.org/project/pytest-bdd-report\n :alt: Python versions\n\n.. |formatting| image:: https://img.shields.io/github/actions/workflow/status/mattiamonti/pytest-bdd-report/automated%20tests.yml?logo=GitHub%20actions&label=Formatting\n :alt: GitHub Workflow Status (with event)\n\n.. |tests| image:: https://img.shields.io/github/actions/workflow/status/mattiamonti/pytest-bdd-report/automated%20tests.yml?logo=pytest&label=Tests\n :alt: GitHub Workflow Status (with event)\n\n.. |ui_tests| image:: https://img.shields.io/github/actions/workflow/status/mattiamonti/pytest-bdd-report/ui%20automated%20tests.yml?logo=robotframework&label=UI%20Tests\n :alt: GitHub Workflow Status (with event)\n\n.. |mstats| image:: https://img.shields.io/pypi/dm/pytest-bdd-report\n :alt: PyPI - Downloads\n\n.. |dstats| image:: https://img.shields.io/pypi/dd/pytest-bdd-report\n :alt: PyPI - Downloads\n\n\n\nThe `pytest-bdd-report` plugin is a useful extension for the `pytest-bdd`_ library that allows you to generate\nuseful and informative reports for BDD (Behavior-Driven Development) tests developed using the pytest-bdd framework.\nThis plugin facilitates the generation of clear and effective HTML reports, providing a comprehensible view of BDD test executions within the project.\n\nFor more, check out the `Documentation`_\n\n----\n\nThis `pytest`_ plugin was generated with `Cookiecutter`_ along with `@hackebrot`_'s `cookiecutter-pytest-plugin`_ template.\n\n\nFeatures\n--------\n\n* **Detailed BDD Reports**: The pytest-bdd-report plugin enables the generation of detailed reports for BDD tests executed using pytest-bdd. These reports clearly show the executed steps, tested scenarios, and obtained results.\n* **HTML Format**: The generated reports are presented in an intuitive and interactive HTML format. This allows developers, testers, and other team members to easily view the status of BDD tests.\n* **Easy Installation**: Installing the plugin is simple and fast. You can install it using the command `pip install pytest-bdd-report`.\n\n\nRequirements\n------------\n\n* Jinja2\n* pytest\n* pytest-bdd\n\n\nInstallation\n------------\n\n1. Ensure that you have `pytest`_ and `pytest-bdd`_ installed in your development environment.\n2. Open a terminal window.\n3. Execute the following command to install the `pytest-bdd-report` plugin via `pip`_ from `PyPI`_\n\n::\n\n $ pip install pytest-bdd-report\n\n\nUsage\n-----\n\nOnce installed, you can generate BDD reports in an HTML file using the following command:\n\n::\n\n $ pytest --bdd-report=\"report.html\"\n\n\nRun tests\n---------\n\nTo run tests:\n\n1. Create a virtual environment\n2. Install the required packages:\n\n::\n\n $ pip install -r requirements.txt\n\n\n3. Install the plugin locally:\n\n::\n\n $ pip install -e .\n\n\n4. Run the unit tests:\n\n::\n\n $ python -m pytest\n\n5. Run the UI tests with Robot Framework:\n\n::\n\n $ cd tests/ui_testing\n $ ./execute_all_ui_tests.sh\n\n\nContributing\n------------\nContributions are very welcome. Tests can be run with `pytest`_ as shown.\n\nLicense\n-------\n\nDistributed under the terms of the `MIT`_ license, \"pytest-bdd-report\" is free and open source software\n\n\nIssues\n------\n\nIf you encounter any problems, please `file an issue`_ along with a detailed description.\n\n.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter\n.. _`@hackebrot`: https://github.com/hackebrot\n.. _`MIT`: http://opensource.org/licenses/MIT\n.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause\n.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt\n.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0\n.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin\n.. _`file an issue`: https://github.com/mattiamonti/pytest-bdd-report/issues\n.. _`pytest`: https://github.com/pytest-dev/pytest\n.. _`tox`: https://tox.readthedocs.io/en/latest/\n.. _`pip`: https://pypi.org/project/pip/\n.. _`PyPI`: https://pypi.org/project\n.. _`pytest-bdd`: https://github.com/pytest-dev/pytest-bdd\n.. _`Documentation`: https://mattia-monti.gitbook.io/pytest-bdd-report/\n",
"bugtrack_url": null,
"license": null,
"summary": "A pytest-bdd plugin for generating useful and informative BDD test reports",
"version": "1.0.3",
"project_urls": {
"Bug Tracker": "https://github.com/mattiamonti/pytest-bdd-report/issues",
"Homepage": "https://github.com/mattiamonti/pytest-bdd-report"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1e1ac9bd771e249bad0fcbe5fbd18d22c85c3735f9a2d8e383e3bf250118d46",
"md5": "c87a28e24ac0c000dc118ef3ec2a7dd3",
"sha256": "9291b6de4337a16c3f4349527c38ed44e4a9cfcf522f0e61be4569bb765b24e7"
},
"downloads": -1,
"filename": "pytest_bdd_report-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c87a28e24ac0c000dc118ef3ec2a7dd3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 29878,
"upload_time": "2024-11-27T20:57:13",
"upload_time_iso_8601": "2024-11-27T20:57:13.681874Z",
"url": "https://files.pythonhosted.org/packages/a1/e1/ac9bd771e249bad0fcbe5fbd18d22c85c3735f9a2d8e383e3bf250118d46/pytest_bdd_report-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9593883bdaf32b888f620e1738bc80736924a9feb864ca0e3b7714e28f90c6ba",
"md5": "d18c8985981a7f40489a3e0ded7a186c",
"sha256": "814f16bb28a5995aeb76b52ce9a5453ea9d75536b5b509f7ba621ec1e43f852a"
},
"downloads": -1,
"filename": "pytest_bdd_report-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d18c8985981a7f40489a3e0ded7a186c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 20541,
"upload_time": "2024-11-27T20:57:15",
"upload_time_iso_8601": "2024-11-27T20:57:15.378749Z",
"url": "https://files.pythonhosted.org/packages/95/93/883bdaf32b888f620e1738bc80736924a9feb864ca0e3b7714e28f90c6ba/pytest_bdd_report-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 20:57:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mattiamonti",
"github_project": "pytest-bdd-report",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"requirements": [
{
"name": "pytest",
"specs": [
[
"==",
"7.1.3"
]
]
},
{
"name": "pytest-bdd",
"specs": [
[
"<",
"7.0.0"
],
[
">=",
"5.0.0"
]
]
},
{
"name": "setuptools",
"specs": [
[
"~=",
"68.0.0"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"~=",
"3.1.2"
]
]
},
{
"name": "robotframework",
"specs": [
[
"~=",
"7.0"
]
]
},
{
"name": "robotframework-seleniumlibrary",
"specs": [
[
"~=",
"6.2.0"
]
]
}
],
"tox": true,
"lcname": "pytest-bdd-report"
}
JSON
