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 Last updated

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

Installation

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

Support

If you find this project useful:

Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

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.8.tar.gz (6.5 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.8-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_text_table-0.1.8.tar.gz
Algorithm Hash digest
SHA256 19ab1134a77a73199f16aae76edb3bb0316a1e9b626f700eb2c1778f2b32dfb4
MD5 7a95f3fe5ee6cb6b4f0be63fc10f3502
BLAKE2b-256 04df53f7ea6027dcfbeb664d24142e93cc9be1f5dfe49208f39c8e850669d300

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_text_table-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 81d8c495e17ff438285a7043317bce6eaf357e6eb400d185e7a0ec6454e253c5
MD5 8efbc8263ed652c19c111c762b921820
BLAKE2b-256 0c7479b3b8ac5a521d3c523977d147059101430001f3b080396f79b3e6a2db30

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