table2ascii
Library for converting 2D Python lists to fancy ASCII/Unicode tables
Documentation and examples are available at table2ascii.rtfd.io
π₯ Installation
pip install -U table2ascii
Requirements: Python 3.7+
π§βπ» Usage
π Convert lists to ASCII tables
from table2ascii import table2ascii
output = table2ascii(
header=["#", "G", "H", "R", "S"],
body=[["1", "30", "40", "35", "30"], ["2", "30", "40", "35", "30"]],
footer=["SUM", "130", "140", "135", "130"],
)
print(output)
"""
βββββββββββββββββββββββββββββββ
β # G H R S β
βββββββββββββββββββββββββββββββ’
β 1 30 40 35 30 β
β 2 30 40 35 30 β
βββββββββββββββββββββββββββββββ’
β SUM 130 140 135 130 β
βββββββββββββββββββββββββββββββ
"""π Set first or last column headings
from table2ascii import table2ascii
output = table2ascii(
body=[["Assignment", "30", "40", "35", "30"], ["Bonus", "10", "20", "5", "10"]],
first_col_heading=True,
)
print(output)
"""
ββββββββββββββ¦ββββββββββββββββββββ
β Assignment β 30 40 35 30 β
β Bonus β 10 20 5 10 β
ββββββββββββββ©ββββββββββββββββββββ
"""π° Set column widths and alignments
from table2ascii import table2ascii, Alignment
output = table2ascii(
header=["#", "G", "H", "R", "S"],
body=[["1", "30", "40", "35", "30"], ["2", "30", "40", "35", "30"]],
first_col_heading=True,
column_widths=[5, 5, 5, 5, 5],
alignments=[Alignment.LEFT] + [Alignment.RIGHT] * 4,
)
print(output)
"""
βββββββ¦ββββββββββββββββββββββββ
β # β G H R S β
βββββββ«ββββββββββββββββββββββββ’
β 1 β 30 40 35 30 β
β 2 β 30 40 35 30 β
βββββββ©ββββββββββββββββββββββββ
"""π¨ Use a preset style
See a list of 30+ preset styles here.
from table2ascii import table2ascii, Alignment, PresetStyle
output = table2ascii(
header=["First", "Second", "Third", "Fourth"],
body=[["10", "30", "40", "35"], ["20", "10", "20", "5"]],
column_widths=[10, 10, 10, 10],
style=PresetStyle.ascii_box
)
print(output)
"""
+----------+----------+----------+----------+
| First | Second | Third | Fourth |
+----------+----------+----------+----------+
| 10 | 30 | 40 | 35 |
+----------+----------+----------+----------+
| 20 | 10 | 20 | 5 |
+----------+----------+----------+----------+
"""
output = table2ascii(
header=["First", "Second", "Third", "Fourth"],
body=[["10", "30", "40", "35"], ["20", "10", "20", "5"]],
style=PresetStyle.plain,
cell_padding=0,
alignments=[Alignment.LEFT] * 4,
)
print(output)
"""
First Second Third Fourth
10 30 40 35
20 10 20 5
"""π² Define a custom style
Check TableStyle for more info and PresetStyle for examples.
from table2ascii import table2ascii, TableStyle
my_style = TableStyle.from_string("*-..*||:+-+:+ *''*")
output = table2ascii(
header=["First", "Second", "Third"],
body=[["10", "30", "40"], ["20", "10", "20"], ["30", "20", "30"]],
style=my_style
)
print(output)
"""
*-------.--------.-------*
| First : Second : Third |
+-------:--------:-------+
| 10 : 30 : 40 |
| 20 : 10 : 20 |
| 30 : 20 : 30 |
*-------'--------'-------*
"""βοΈ Options
All parameters are optional.
| Option | Type | Default | Description |
|---|---|---|---|
header |
List[Any] |
None |
First table row seperated by header row seperator. Values should support str(). |
body |
List[List[Any]] |
None |
List of rows for the main section of the table. Values should support str(). |
footer |
List[Any] |
None |
Last table row seperated by header row seperator. Values should support str(). |
column_widths |
List[Optional[int]] |
None (automatic) |
List of column widths in characters for each column |
alignments |
List[Alignment] |
None (all centered) |
Column alignments (ex. [Alignment.LEFT, Alignment.CENTER, Alignment.RIGHT]) |
style |
TableStyle |
double_thin_compact |
Table style to use for the table* |
first_col_heading |
bool |
False |
Whether to add a heading column seperator after the first column |
last_col_heading |
bool |
False |
Whether to add a heading column seperator before the last column |
cell_padding |
int |
1 |
The minimum number of spaces to add between the cell content and the cell border. |
*See a list of all preset styles here.
See the API Reference for more info.
π¨βπ¨ Use cases
π¨οΈ Discord messages and embeds
- Display tables nicely inside markdown code blocks on Discord
- Useful for making Discord bots with Discord.py
π» Terminal outputs
- Tables display nicely whenever monospace fonts are fully supported
- Tables make terminal outputs look more professional
π€ Contributing
Contributions are welcome!
See CONTRIBUTING.md for more details on how to get involved.