pytest-md-report 0.0.3

A pytest plugin to make a test results report with Markdown table format.

pytest-md-report

• Summary

• Installation

• Usage

• Options

  • Command options

  • ini-options

• Dependencies

Summary

A pytest plugin to make a test results report with Markdown table format.

Installation

pip install pytest-md-report

Usage

$ pytest --md-report examples/

Output example

Increase verbosity level:

$ pytest -v --md-report examples/

Output example (verbose)

Options

Command options

make test results report with markdown table format:
  --md-report           create markdown report. you can also specify the value
                        with PYTEST_MD_REPORT environment variable.
  --md-report-verbose=VERBOSITY_LEVEL
                        verbosity level for pytest-md-report. if not set, using
                        verbosity level of pytest. defaults to 0. you can also
                        specify the value with PYTEST_MD_REPORT_VERBOSE
                        environment variable.
  --md-report-color={auto,text,never}
                        auto: display colored (text and background) reports by
                        using ANSI escape codes. text: display colored (text)
                        reports by using ANSI escape codes. never: diplay report
                        without color. defaults to 'auto'. you can also specify
                        the value with PYTEST_MD_REPORT_COLOR environment
                        variable.

ini-options

[pytest] ini-options in the first pytest.ini|tox.ini|setup.cfg file found:

md_report (bool):     create markdown report.
md_report_verbose (string):
                      verbosity level for pytest-md-report. if not set, using
                      verbosity level of pytest. defaults to 0.
md_report_color (string):
                      auto: display colored (text and background) reports by
                      using ANSI escape codes. text: display colored (text)
                      reports by using ANSI escape codes. never: diplay report
                      without color. defaults to 'auto'.

Example of setup.cfg:

[tool:pytest]
md_report = True
md_report_verbose = 0
md_report_color = auto

Dependencies

Python 3.5+

• pytablewriter

• pytest

• typepy