mdreport

Build Markdown reports programmatically using a chainable fluent interface. Add headings, text, lists, code blocks, templates, and Polars DataFrames.

Install

pip install mdreport

mdreport requires Python 3.12 or later.

Create a report

from mdreport import MarkdownReport

report = (
    MarkdownReport()
    .title("Q3 review")
    .heading("Revenue")
    .text("Revenue grew {{revenue_growth}}%.", params={"revenue_growth": 4})
    .bullet_list(["EMEA grew 6%", "APAC grew 2%"])
)

report.save("q3-review.md")

Each method adds content and returns the report. You can chain methods or call them one at a time.

Read the documentation

• Usage examples
  • Add common content
  • Add a callout
  • Add figures
  • Add a DataFrame
  • Add template values
  • Add frontmatter
  • Add a table of contents
  • Link to headings
  • Render or save
• API reference
  • Report
  • Blocks
  • Heading anchors
  • Extension protocols
  • Errors
  • Token builders
  • Template helpers
  • DataFrame helpers
  • Parser
• Extensions
  • Create a block
  • Add a block
  • Return tokens
  • Read the finished document