pytest-bdd-report


Namepytest-bdd-report JSON
Version 1.0.1 PyPI version JSON
download
home_page
SummaryA pytest-bdd plugin for generating useful and informative BDD test reports
upload_time2024-02-19 16:44:21
maintainer
docs_urlNone
author
requires_python>=3.5
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =================
pytest-bdd-report
=================

|python| |pypi| |formatting| |tests|

|dstats| |mstats|


.. |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)

.. |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.

----

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 tests:

::

    $ python -m pytest


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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pytest-bdd-report",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "Mattia Monti <mattiamonti2001@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/2d/16/e7e8b976f7a5bf16b9e874c105d7732523fe0fe4548124a84e66fe594eee/pytest_bdd_report-1.0.1.tar.gz",
    "platform": null,
    "description": "=================\npytest-bdd-report\n=================\n\n|python| |pypi| |formatting| |tests|\n\n|dstats| |mstats|\n\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.. |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\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 tests:\n\n::\n\n    $ python -m pytest\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",
    "bugtrack_url": null,
    "license": "",
    "summary": "A pytest-bdd plugin for generating useful and informative BDD test reports",
    "version": "1.0.1",
    "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": "24fa046ba5ed62fc673dc9270fab78fb1704acaf5d42ab6c48be24ee7162948d",
                "md5": "357f46b9fe97c9c48515577bb615b3ad",
                "sha256": "08f2fde8766d4f5ebcdbda046e6227912da44489cc71e36420e71fd619d66474"
            },
            "downloads": -1,
            "filename": "pytest_bdd_report-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "357f46b9fe97c9c48515577bb615b3ad",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 29278,
            "upload_time": "2024-02-19T16:44:20",
            "upload_time_iso_8601": "2024-02-19T16:44:20.499402Z",
            "url": "https://files.pythonhosted.org/packages/24/fa/046ba5ed62fc673dc9270fab78fb1704acaf5d42ab6c48be24ee7162948d/pytest_bdd_report-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2d16e7e8b976f7a5bf16b9e874c105d7732523fe0fe4548124a84e66fe594eee",
                "md5": "ba96125f16a22b3b4a0a83be3d1c3d25",
                "sha256": "1f9dd477f4fdaf713a161d4fc72933e7c117fbc17cbc27840f7fd1fd946bb924"
            },
            "downloads": -1,
            "filename": "pytest_bdd_report-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ba96125f16a22b3b4a0a83be3d1c3d25",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 19857,
            "upload_time": "2024-02-19T16:44:21",
            "upload_time_iso_8601": "2024-02-19T16:44:21.841084Z",
            "url": "https://files.pythonhosted.org/packages/2d/16/e7e8b976f7a5bf16b9e874c105d7732523fe0fe4548124a84e66fe594eee/pytest_bdd_report-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-19 16:44:21",
    "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": [],
    "tox": true,
    "lcname": "pytest-bdd-report"
}
        
Elapsed time: 0.27812s