Skip to main content

Render data as clean ASCII/Unicode tables in the terminal with zero configuration

Project description

philiprehberger-text-table

Tests PyPI version License

Render data as clean ASCII/Unicode tables in the terminal with zero configuration.

Install

pip install philiprehberger-text-table

Usage

from philiprehberger_text_table import table

headers = ["Name", "Age", "City"]
rows = [
    ["Alice", 30, "New York"],
    ["Bob", 25, "London"],
    ["Charlie", 35, "Tokyo"],
]

print(table(headers, rows))

Output:

┌─────────┬─────┬──────────┐
│ Name    │ Age │ City     │
├─────────┼─────┼──────────┤
│ Alice   │  30 │ New York │
│ Bob     │  25 │ London   │
│ Charlie │  35 │ Tokyo    │
└─────────┴─────┴──────────┘

From dictionaries

from philiprehberger_text_table import from_dicts

data = [
    {"name": "Alice", "score": 95},
    {"name": "Bob", "score": 87},
]

print(from_dicts(data))

From CSV

from philiprehberger_text_table import from_csv

print(from_csv("data.csv"))

Styles

# ASCII style
print(table(headers, rows, style="ascii"))

# Markdown style
print(table(headers, rows, style="markdown"))

# Minimal style (no borders)
print(table(headers, rows, style="minimal"))

# Compact style (no outer borders)
print(table(headers, rows, style="compact"))

Truncation

print(table(headers, rows, max_width=10))

API

Function Description
table(headers, rows, *, style="unicode", max_width=None) Render a table from headers and row data
from_dicts(data, *, style="unicode", max_width=None) Render a table from a list of dictionaries
from_csv(path, *, style="unicode", max_width=None) Read a CSV file and render as a table

Styles: "unicode", "ascii", "markdown", "minimal", "compact"

Development

pip install -e .
python -m pytest tests/ -v

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

philiprehberger_text_table-0.1.4.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_text_table-0.1.4-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_text_table-0.1.4.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_text_table-0.1.4.tar.gz
Algorithm Hash digest
SHA256 d5a06e1d47da1db4fc50e68557bd6a06562c1919b513da698a016fad508ed5e2
MD5 1548f7bda81d937d2f8a916535de0e7e
BLAKE2b-256 a2d380828e0e6f2f49eb2aeabce74b3ebc871af6e134a06cbb3c8c0680683280

See more details on using hashes here.

File details

Details for the file philiprehberger_text_table-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_text_table-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 602cce80d54bbc78705cba5b3e9c560adcf9b0f961ba7667d541eeb367080254
MD5 965ac44a8601b705ad601674fa3119d6
BLAKE2b-256 de714c1778be597e6993cb6fd96879d24849a3e1721555d6d2c6176b8732253d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page