sqlcompyre.report.writers.markdown module

class sqlcompyre.report.writers.markdown.MarkdownWriter(formatter: Formatter)[source]

Bases: Writer

Writer that outputs reports to standard output as Markdown.

This writer is especially useful for printing comparisons to GitHub, e.g. as part of comments inside pull requests.

Methods

write(reports[, hide_matching_columns])

Write the provided reports to this writer's sink.
write(reports: dict[str, Report], hide_matching_columns: bool = False) → None[source]

Write the provided reports to this writer’s sink.

Args:

reports: A set of reports, mapped from an identifier to the report. hide_matching_columns: Whether to hide columns from the report which show a perfect

(i.e. 100%) match rate.