4.1. Basic usage¶

Basic usage of the pytablewriter is as follows:

Create a writer instance that corresponds to the format you want to write
Assign a value to instance variables (such as table_name/headers/value_matrix) of the writer
Call the write_table method

The next example show how to write a table with markdown format:

Sample Code

Write a table¶

import pytablewriter as ptw

def main():
    writer = ptw.MarkdownTableWriter()
    writer.table_name = "zone"
    writer.headers = ["zone_id", "country_code", "zone_name"]
    writer.value_matrix = [
        ["1", "AD", "Europe/Andorra"],
        ["2", "AE", "Asia/Dubai"],
        ["3", "AF", "Asia/Kabul"],
        ["4", "AG", "America/Antigua"],
        ["5", "AI", "America/Anguilla"],
    ]

    writer.write_table()

if __name__ == "__main__":
    main()

Output

# zone
|zone_id|country_code|   zone_name    |
|------:|------------|----------------|
|      1|AD          |Europe/Andorra  |
|      2|AE          |Asia/Dubai      |
|      3|AF          |Asia/Kabul      |
|      4|AG          |America/Antigua |
|      5|AI          |America/Anguilla|

The default output stream is the standard output for text format writers, binary format writers will write to a binary file that opened by open method.