Metadata-Version: 2.1
Name: pytest-richtrace
Version: 0.2.1
Summary: A pytest plugin that displays the names and information of the pytest hook functions as they are executed.
License: Apache-2.0
Author: Simon Kennedy
Author-email: sffjunkie+code@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: pydantic (>=2.0a1)
Requires-Dist: rich (>=13.3.5,<14.0.0)
Description-Content-Type: text/markdown

# pytest-richtrace

A pytest plugin that dumps the stages of the pytest testing process to the terminal.

It uses `rich` to add formatting to the output.

## Installation

Install using pip

```shell
pip install pytest_richtrace
```

## Usage

To activate the plugin add the `--rich-trace` option to the `pytest` command line.

## Sample output

### Full test run

#### Quiet output

```shell
pytest --rich-trace -q
```

<img src="https://github.com/sffjunkie/pytest-richtrace/raw/main/docs/quickstart/output-quiet.svg" width="700px" alt="quiet output">

#### Normal output

```shell
pytest --rich-trace
```

<img src="https://github.com/sffjunkie/pytest-richtrace/raw/main/docs/quickstart/output.svg" width="700px" alt="normal output">

### Verbose output

```shell
pytest --rich-trace --verbose
```

<img src="https://github.com/sffjunkie/pytest-richtrace/raw/main/docs/quickstart/output-verbose.svg" width="700px" alt="verbose output">

### --collect-only output

```shell
pytest --rich-trace --collect-only
```

<img src="https://github.com/sffjunkie/pytest-richtrace/raw/main/docs/quickstart/output-collect-only.svg" width="700px" alt="--collect-only output">

