terminaltables

3.1.10 · abandoned · verified Thu Apr 09

terminaltables is a Python library designed to easily draw tables in terminal/console applications from a nested list of strings. It supports multi-line rows and various table styles like ASCII, single-line, double-line, and GitHub Flavored Markdown. The current version is 3.1.10, but the project is no longer actively maintained.

Warnings

breaking The `terminaltables` project (version 3.1.10 and earlier) is no longer actively maintained since December 2021. Users are strongly encouraged to consider using `terminaltables3` (`pip install terminaltables3`), which is a maintained fork designed to be a drop-in replacement.
Fix: Migrate to `terminaltables3` by installing it and replacing `from terminaltables import ...` with `from terminaltables3 import ...`.
breaking Classes `UnixTable`, `WindowsTable`, and `WindowsTableDouble` were removed and replaced.
Fix: Use `SingleTable` instead of `UnixTable`. Use `DoubleTable` instead of `WindowsTable` or `WindowsTableDouble`.
breaking The `padded_table_data` property and `join_row()` method were removed.
Fix: Review your code for direct usage of these properties/methods and adapt to the current API, which handles internal data formatting differently. The `table` property should be used to retrieve the rendered table string.
breaking Python 2.6 support was removed.
Fix: Ensure your project runs on Python 2.7+ or Python 3.3+. Modern usage should target Python 3.
gotcha When generating multiple tables in a loop, a common mistake is to create a new `table_data` list and `AsciiTable` object in each iteration. This results in separate, small tables being printed.
Fix: Aggregate all data into a single `table_data` list (or similar structure) first, then create and print a single `AsciiTable` instance outside the loop to produce one continuous table.

Install

pip install terminaltables PyPI

Imports

AsciiTable
```
from terminaltables import AsciiTable
```
SingleTable
```
from terminaltables import SingleTable
```
UnixTable was renamed to SingleTable in v2.0.0.
DoubleTable
```
from terminaltables import DoubleTable
```
WindowsTable (and WindowsTableDouble) were renamed to DoubleTable in v2.0.0.

GithubFlavoredMarkdownTable

from terminaltables import GithubFlavoredMarkdownTable

Quickstart

This quickstart demonstrates how to create a basic ASCII table using `AsciiTable` by providing a list of lists. It also shows how to set a table title. Other table types like `SingleTable` and `DoubleTable` are used similarly.

from terminaltables import AsciiTable

table_data = [
    ['Heading1', 'Heading2', 'Heading3'],
    ['Row1 Col1', 'Row1 Col2', 'Row1 Col3'],
    ['Row2 Col1', 'Row2 Col2 with a long text that wraps', 'Row2 Col3'],
    ['Row3 Col1', 'Row3 Col2', 'Row3 Col3']
]

table = AsciiTable(table_data)
# You can also set a title
table.title = 'My Awesome Table'

# Adjust column alignment (l=left, c=center, r=right)
# table.justify_columns = {'Heading1': 'left', 'Heading2': 'center'}

print(table.table)

view raw JSON →