Markdown Table Generator

Warnings

• breaking The import namespace changed from `markdownTable` to `py_markdown_table.markdown_table` in v1.0.0. Older versions (<1.0.0, e.g., v0.4.0) provided a warning about this impending change.
  Fix: Update your import statements from `from markdownTable import markdownTable` to `from py_markdown_table.markdown_table import markdown_table`.
• breaking Deprecated methods were removed in v1.0.0 as part of a code cleanup and simplification.
  Fix: Refer to the v1.0.0 changelog and updated documentation on GitHub for current method equivalents and refactor your code accordingly.
• gotcha The library expects input data as a list of dictionaries where all dictionaries (rows) must have uniform keys (column headers). Inconsistent keys may lead to unexpected table structures or errors.
  Fix: Ensure all dictionary items in your input list share the exact same keys to represent consistent columns across all rows.
• gotcha Data validation was added in v1.0.0 for robustness. If your data might not strictly adhere to expected formats, you can skip validation using the `skip_data_validation` parameter in the constructor.
  Fix: If experiencing issues with new validation rules, consider reviewing your data or setting `skip_data_validation=True` as a temporary workaround, understanding the potential risks.
• gotcha Rendering of multiline content and emojis can vary between different Markdown viewers. GitHub's markdown preview, for instance, might show slight offsets in cells containing emojis compared to a monospaced terminal.
  Fix: Test your generated markdown in the target rendering environment (e.g., GitHub, specific IDEs, or documentation tools) to ensure it appears as intended, especially for complex layouts or heavy emoji use.

Install

• pip install py-markdown-table Install with pip

Imports

• markdown_table

  from py_markdown_table.markdown_table import markdown_table

  The import path was changed in preparation for v1.0.0. The old namespace `markdownTable` was deprecated and fully removed in v1.0.0.

Quickstart

This example demonstrates how to create a basic markdown table from a list of dictionaries. The keys of the dictionaries become the column headers, and the values form the rows of the table.

from py_markdown_table.markdown_table import markdown_table

data = [
    {"Product": "Smartphone", "Brand": "Apple", "Price": 999.99},
    {"Product": "Laptop", "Brand": "Dell", "Price": 1299.99}
]

markdown = markdown_table(data).get_markdown()
print(markdown)