dashtable 1.2.8

A library for converting a HTML tables into ASCII tables

Contents

• Video Tutorial

• Introduction

• Installation

• Example Usage

  • HTML to reStructured Table

  • HTML to MarkDown Table

  • List of Lists to reStructered Table

  • List of Lists to Markdown Table

Video Tutorial

Introduction

Use DashTable to create ASCII tables like this reStructured Table:

+------------+------------+------------+
| Header 1   | Header 2   | Header 3   |
+============+============+============+
| body row 1 | column 2   | column 3   |
+------------+------------+------------+
| body row 2 | Cells may span columns. |
+------------+------------+------------+
| body row 3 | Cells may  | - Cells    |
+------------+ span rows. | - contain  |
| body row 4 |            | - blocks.  |
+------------+------------+------------+

Installation

pip install dashtable

Example Usage

HTML to reStructured Table

html2rst requires a filepath or a string to work.

from dashtable import html2rst

filepath = "path/to/html/file.html"
print(html2rst(filepath, force_headers=False))

Command Line Method:

python html2rst.py input.html output.rst --force_headers

HTML to MarkDown Table

html2md requires a filepath or a string to work.

from dashtable import html2md

filepath = "path/to/html/file.html"
print(html2md(filepath))

Command line method:

python html2md.py input.html output.md

List of Lists to reStructered Table

from dashtable import data2rst

table = [
    ['Row\nSpan', 'Header'],
    ['Cell', ''],
    ['Column Span', '']
    ]

column_span = ([0, 0], [1, 0])
row_span = ([2, 0], [2, 1])

my_spans = [column_span, row_span]

print(data2rst(table, spans=my_spans, use_headers=True))

List of Lists to Markdown Table

from dashtable import data2md

table = [
    ['Header 1', 'Header 2', 'Header 3'],
    ['Column 1', 'Column 2', 'Column 3']
]

print(data2md(table))