https://github.com/vedro-universe/vedro-allure-reporter

Allure reporter for Vedro testing framework
https://github.com/vedro-universe/vedro-allure-reporter

allure vedro vedro-plugin

Last synced: 5 months ago
JSON representation

Allure reporter for Vedro testing framework

• Host: GitHub
• URL: https://github.com/vedro-universe/vedro-allure-reporter
• Owner: vedro-universe
• License: apache-2.0
• Created: 2021-07-13T14:14:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-12-20T16:41:00.000Z (11 months ago)
• Last Synced: 2025-05-18T22:13:37.351Z (6 months ago)
• Topics: allure, vedro, vedro-plugin
• Language: Python
• Homepage: https://vedro.io/docs/integrations/allure-reporter
• Size: 134 KB
• Stars: 4
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Vedro Allure Reporter

[![Codecov](https://img.shields.io/codecov/c/github/vedro-universe/vedro-allure-reporter/master.svg?style=flat-square)](https://codecov.io/gh/vedro-universe/vedro-allure-reporter)

[![PyPI](https://img.shields.io/pypi/v/vedro-allure-reporter.svg?style=flat-square)](https://pypi.python.org/pypi/vedro-allure-reporter/)

[![PyPI - Downloads](https://img.shields.io/pypi/dm/vedro-allure-reporter?style=flat-square)](https://pypi.python.org/pypi/vedro-allure-reporter/)

[![Python Version](https://img.shields.io/pypi/pyversions/vedro-allure-reporter.svg?style=flat-square)](https://pypi.python.org/pypi/vedro-allure-reporter/)

[Allure](https://docs.qameta.io/allure/) reporter for [Vedro](https://vedro.io/) testing framework.

## Installation

Quick



For a quick installation, you can use a plugin manager as follows:

```shell

$ vedro plugin install vedro-allure-reporter

```



Manual



To install manually, follow these steps:

1. Install the package using pip:

```shell

$ pip3 install vedro-allure-reporter

```

2. Next, activate the plugin in your `vedro.cfg.py` configuration file:

```python

# ./vedro.cfg.py

import vedro

import vedro_allure_reporter

class Config(vedro.Config):

    class Plugins(vedro.Config.Plugins):

        class AllureReporter(vedro_allure_reporter.AllureReporter):

            enabled = True

```



## Usage

To run tests with the Allure reporter, use the following command:

```shell

$ vedro run -r rich allure

```

This command executes your tests and saves the report data in the `./allure_reports` directory.

To generate a report from the saved data, use the [Allure command-line tool](https://docs.qameta.io/allure/#_installing_a_commandline) as follows:

```shell

$ allure serve ./allure_reports

```

This command will serve up the report ([demo](https://allure-framework.github.io/allure-demo/5/)).

---

Explore more at https://vedro.io/docs/integrations/allure-reporter