Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@thombashi
thombashi committed Oct 8, 2023
1 parent 4859e33 commit 72b8804
Showing 1 changed file with 82 additions and 26 deletions.
108 changes: 82 additions & 26 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,53 +154,83 @@ 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 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, use the verbosity level of pytest.
Defaults to 0.
you can also specify the value with PYTEST_MD_REPORT_VERBOSE environment variable.
you can also specify the value with
PYTEST_MD_REPORT_VERBOSE environment variable.
--md-report-output=FILEPATH
Path to a file to the outputs test report.
Overwrite a file content if the file already exists.
you can also specify the value with PYTEST_MD_REPORT_OUTPUT environment variable.
--md-report-tee output test report for both standard output and a file. you can also specify the value with PYTEST_MD_REPORT_TEE environment variable.
you can also specify the value with
PYTEST_MD_REPORT_OUTPUT environment variable.
--md-report-tee output test report for both standard output and a file.
you can also specify the value with PYTEST_MD_REPORT_TEE
environment variable.
--md-report-color={auto,text,never}
How coloring output reports.
auto: detect the output destination and colorize reports appropriately with the output.
for terminal output, render colored (text and background) reports using ANSI escape codes.
auto: detect the output destination and colorize reports
appropriately with the output.
for terminal output, render colored (text and
background) reports using ANSI escape codes.
for file output, render the report without color.
text: render colored text reports by using ANSI escape codes.
text: render colored text reports by using ANSI escape
codes.
never: render report without color.
Defaults to 'auto'.
you can also specify the value with PYTEST_MD_REPORT_COLOR environment variable.
you can also specify the value with
PYTEST_MD_REPORT_COLOR environment variable.
--md-report-margin=MARGIN
Margin size for each cell.
Defaults to 1.
you can also specify the value with PYTEST_MD_REPORT_MARGIN environment variable.
you can also specify the value with
PYTEST_MD_REPORT_MARGIN environment variable.
--md-report-zeros={number,empty}
Rendering method for results of zero values.
number: render as a digit number (0).
empty: not rendering.
Automatically set to 'number' when CI environment variable is set to
TRUE (case insensitive) to display reports correctly at CI services.
Automatically set to 'number' when CI environment
variable is set to
TRUE (case insensitive) to display reports correctly at
CI services.
Defaults to 'number'.
you can also specify the value with PYTEST_MD_REPORT_ZEROS environment variable.
you can also specify the value with
PYTEST_MD_REPORT_ZEROS environment variable.
--md-report-success-color=MD_REPORT_SUCCESS_COLOR
Text color of succeeded results.
Specify a color name (one of the black/red/green/yellow/blue/magenta/cyan/white/lightblack/lightred/lightgreen/lightyellow/lightblue/lightmagenta/lightcyan/lightwhite) or a color code (e.g. #ff1020).
Specify a color name (one of the black/red/green/yellow/
blue/magenta/cyan/white/lightblack/lightred/lightgreen/l
ightyellow/lightblue/lightmagenta/lightcyan/lightwhite)
or a color code (e.g. #ff1020).
Defaults to 'light_green'.
you can also specify the value with PYTEST_MD_REPORT_SUCCESS_COLOR environment variable.
you can also specify the value with
PYTEST_MD_REPORT_SUCCESS_COLOR environment variable.
--md-report-skip-color=MD_REPORT_SKIP_COLOR
Text color of skipped results.
Specify a color name (one of the black/red/green/yellow/blue/magenta/cyan/white/lightblack/lightred/lightgreen/lightyellow/lightblue/lightmagenta/lightcyan/lightwhite) or a color code (e.g. #ff1020).
Specify a color name (one of the black/red/green/yellow/
blue/magenta/cyan/white/lightblack/lightred/lightgreen/l
ightyellow/lightblue/lightmagenta/lightcyan/lightwhite)
or a color code (e.g. #ff1020).
Defaults to 'light_yellow'.
you can also specify the value with PYTEST_MD_REPORT_SKIP_COLOR environment variable.
you can also specify the value with
PYTEST_MD_REPORT_SKIP_COLOR environment variable.
--md-report-error-color=MD_REPORT_ERROR_COLOR
Text color of failed results.
Specify a color name (one of the black/red/green/yellow/blue/magenta/cyan/white/lightblack/lightred/lightgreen/lightyellow/lightblue/lightmagenta/lightcyan/lightwhite) or a color code (e.g. #ff1020).
Specify a color name (one of the black/red/green/yellow/
blue/magenta/cyan/white/lightblack/lightred/lightgreen/l
ightyellow/lightblue/lightmagenta/lightcyan/lightwhite)
or a color code (e.g. #ff1020).
Defaults to 'light_red'.
you can also specify the value with PYTEST_MD_REPORT_ERROR_COLOR environment variable.
you can also specify the value with
PYTEST_MD_REPORT_ERROR_COLOR environment variable.
--md-report-flavor={common_mark,github,gfm,jekyll,kramdown}
Markdown flavor of the output report.
Defaults to 'common_mark'.
you can also specify the value with
PYTEST_MD_REPORT_FLAVOR environment variable.


ini-options
Expand All @@ -211,24 +241,50 @@ ini-options

md_report (bool): Create Markdown report.
md_report_verbose (string):
Verbosity level for pytest-md-report. If not set, use the verbosity level of pytest. Defaults to 0.
Verbosity level for pytest-md-report. If not set, use
the verbosity level of pytest. Defaults to 0.
md_report_color (string):
How coloring output reports. auto: detect the output destination and colorize reports appropriately with the output. for terminal output, render colored (text and background) reports using ANSI escape codes. for file output, render the report without color. text: render colored text reports by using ANSI
escape codes. never: render report without color. Defaults to 'auto'.
How coloring output reports. auto: detect the output
destination and colorize reports appropriately with the
output. for terminal output, render colored (text and
background) reports using ANSI escape codes. for file
output, render the report without color. text: render
colored text reports by using ANSI escape codes. never:
render report without color. Defaults to 'auto'.
md_report_output (string):
Path to a file to the outputs test report. Overwrite a file content if the file already exists.
Path to a file to the outputs test report. Overwrite a
file content if the file already exists.
md_report_tee (string):
output test report for both standard output and a file.
md_report_margin (string):
Margin size for each cell. Defaults to 1.
md_report_zeros (string):
Rendering method for results of zero values. number: render as a digit number (0). empty: not rendering. Automatically set to 'number' when CI environment variable is set to TRUE (case insensitive) to display reports correctly at CI services. Defaults to 'number'.
Rendering method for results of zero values. number:
render as a digit number (0). empty: not rendering.
Automatically set to 'number' when CI environment
variable is set to TRUE (case insensitive) to display
reports correctly at CI services. Defaults to 'number'.
md_report_success_color (string):
Text color of succeeded results. Specify a color name (one of the black/red/green/yellow/blue/magenta/cyan/white/lightblack/lightred/lightgreen/lightyellow/lightblue/lightmagenta/lightcyan/lightwhite) or a color code (e.g. #ff1020). Defaults to 'light_green'.
Text color of succeeded results. Specify a color name
(one of the black/red/green/yellow/blue/magenta/cyan/whi
te/lightblack/lightred/lightgreen/lightyellow/lightblue/
lightmagenta/lightcyan/lightwhite) or a color code (e.g.
#ff1020). Defaults to 'light_green'.
md_report_skip_color (string):
Text color of skipped results. Specify a color name (one of the black/red/green/yellow/blue/magenta/cyan/white/lightblack/lightred/lightgreen/lightyellow/lightblue/lightmagenta/lightcyan/lightwhite) or a color code (e.g. #ff1020). Defaults to 'light_yellow'.
Text color of skipped results. Specify a color name (one
of the black/red/green/yellow/blue/magenta/cyan/white/li
ghtblack/lightred/lightgreen/lightyellow/lightblue/light
magenta/lightcyan/lightwhite) or a color code (e.g.
#ff1020). Defaults to 'light_yellow'.
md_report_error_color (string):
Text color of failed results. Specify a color name (one of the black/red/green/yellow/blue/magenta/cyan/white/lightblack/lightred/lightgreen/lightyellow/lightblue/lightmagenta/lightcyan/lightwhite) or a color code (e.g. #ff1020). Defaults to 'light_red'.
Text color of failed results. Specify a color name (one
of the black/red/green/yellow/blue/magenta/cyan/white/li
ghtblack/lightred/lightgreen/lightyellow/lightblue/light
magenta/lightcyan/lightwhite) or a color code (e.g.
#ff1020). Defaults to 'light_red'.
md_report_flavor (string):
Markdown flavor of the output report. Defaults to
'common_mark'.


Dependencies
Expand Down

0 comments on commit 72b8804

Please sign in to comment.