Skip to main content

Python library to print tables and line charts in Terminal.

Project description

outfancy

Table printing and Line plotting in Terminal

What is it?

Outfancy is a Python library for printing tables and charts in the terminal. It's a quick way to visualize data when you don't have a GUI, and it integrates easily into your programs. You can install it with uv or pip and use it anywhere.

This was the first library I ever built when I was 16 :). It's been modernized to support Python 3.10+, fix bugs, add type hints, improve logging, and enhance performance, but the original style is still there: raw, exploratory teenage code.

Documentation

Installation

Install as a library (uv)

uv add outfancy

Install as a CLI tool (uv)

uv tool install outfancy

Install with pip

pip install outfancy

Features

  • Quick table printing - Print formatted tables in the terminal with automatic column width detection
  • LineChart plotting - Create line charts with linear interpolation
  • Customizable formatting - Configure separators, widths, and column priorities
  • Real-time column rearrangement - Dynamically reorder columns
  • Auto-generated labels - Automatic label creation above tables
  • Oneline printing - Single-line updates for real-time applications
  • Color support - Add ANSI colors to table fields
  • Type hints - Full type annotation support for better IDE integration
  • Configurable logging - Flexible logging system with multiple severity levels
  • Data type auto-detection - Automatic detection of ID, name, date, time, value, and description columns

Quick Start

Basic Table

import outfancy.table

table = outfancy.table.Table()
dataset = [(1, 'Marie'), (2, 'Joseph')]
print(table.render(dataset))

Line Chart

import outfancy.chart
from math import sin

line_chart = outfancy.chart.LineChart()
dataset = [(i, sin(i)) for i in range(10)]
line_chart.plot(dataset)
print(line_chart.render(color=True))

Large Table with Pagination

from outfancy.table import LargeTable

large_table = LargeTable()
large_dataset = [(i, f'User {i}', f'user{i}@example.com') for i in range(100)]
print(large_table.render(large_dataset))

Empty State Customization

from outfancy.table import Table, LargeTable

t = Table()
t.set_empty_string('No data available')

lt = LargeTable()
lt.set_empty_string('No data available')

This sets the string displayed when a table cell has no value.

CLI (Added in 2026)

After installing outfancy, the outfancy command is available in your terminal.

Table

Render tabular data from stdin or a file:

# CSV from stdin (first row used as headers)
printf "id,name,value\n1,foo,100\n2,bar,200" | outfancy table

# From a file
outfancy table data.csv

# TSV input
cat data.tsv | outfancy table --tsv

# JSON input (array of objects or array of arrays)
cat data.json | outfancy table --json

# Custom headers
printf "1,foo,100\n2,bar,200" | outfancy table --labels "ID,Name,Value"

# Hide headers
cat data.csv | outfancy table --no-labels

# Select and reorder columns
cat data.csv | outfancy table --order 0,2,1

# Custom column separator
cat data.csv | outfancy table --separator " | "

# Equal width for all columns
cat data.csv | outfancy table --width-equal

# Use first row as column headers (CSV/TSV)
cat data.csv | outfancy table --has-headers

Chart

Render x,y pairs as a line chart:

# From stdin (one x,y pair per line)
printf "1,10\n2,25\n3,15\n4,30\n5,20" | outfancy chart

# With title and colors
printf "1,10\n2,25\n3,15\n4,30\n5,20" | outfancy chart --name "Sales" --color

# From a file
outfancy chart data.csv

Demo

Run the interactive demo:

outfancy-demo

Development

Development installation (pip)

git clone https://github.com/carlosplanchon/outfancy.git
cd outfancy
pip install -e .

Development installation (uv)

git clone https://github.com/carlosplanchon/outfancy.git
cd outfancy
uv venv
uv pip install -e ".[dev]"

Running tests

The project includes a comprehensive test suite covering all major functionality:

# Run all tests
pytest

# Run with verbose output
pytest -v

# Run specific test file
pytest tests/test_table.py

# Run tests with coverage
pytest --cov=outfancy

The test suite includes:

  • 79 test functions covering Table, Oneline, and LargeTable classes
  • Unit tests for initialization, configuration, and rendering
  • Integration tests for complex workflows
  • Regression tests for documented bug fixes
  • Edge case validation for data integrity

Logging Configuration

Outfancy uses a configurable logging system. By default, only WARNING and above messages are shown:

import logging
import outfancy.table

# Enable debug logging
logging.getLogger('outfancy').setLevel(logging.DEBUG)

# Create table with debug output
table = outfancy.table.Table()

See LOGGING.md for detailed logging configuration options.

Contributing

Contributions are welcome! Here's how you can help:

  1. Report bugs - Open an issue describing the problem
  2. Suggest features - Share your ideas for improvements
  3. Submit pull requests - Fix bugs or implement features
  4. Improve documentation - Help make the docs clearer
  5. Write tests - Add test coverage for edge cases

Code style

  • Follow existing code patterns
  • Add type hints to new functions
  • Include tests for new features
  • Update documentation as needed

Examples & Demos

Line Chart Example

License

MIT License - see LICENSE file for details

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

outfancy-0.10.0.tar.gz (33.8 kB view details)

Uploaded Source

Built Distribution

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

outfancy-0.10.0-py3-none-any.whl (33.1 kB view details)

Uploaded Python 3

File details

Details for the file outfancy-0.10.0.tar.gz.

File metadata

  • Download URL: outfancy-0.10.0.tar.gz
  • Upload date:
  • Size: 33.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for outfancy-0.10.0.tar.gz
Algorithm Hash digest
SHA256 b346d8fea488e943de64d838aed5710215e042be08d1d8640192958110ff814f
MD5 161b5f91ade9e227578735ad9774e0eb
BLAKE2b-256 065b14d4effd521b7500b67ce2465ffc4b34ec524d462787ad74be4561564bb8

See more details on using hashes here.

File details

Details for the file outfancy-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: outfancy-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 33.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for outfancy-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 89e65c7b765652f18976e716759c5d96dc87dcecef437aa7ab0dea6fd7d61a8c
MD5 eef321bcd9972e5daa70d38cede30e01
BLAKE2b-256 405a3378d8aa9ca8e3333860a6bbb96c40e7c25fca646604f29273693d9c97e9

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