styledconsole 0.10.3

A modern Python library for elegant terminal output with rich formatting, colors, emoji support, and export capabilities

✨ StyledConsole

A modern Python library for elegant terminal output — rich formatting, colors, emojis, gradients, and export capabilities built on top of Rich.

🚧 Early Access — Currently available on TestPyPI. Some features may be experimental.

pip install -i https://test.pypi.org/simple/ styledconsole

---

🎨 Visual Gallery

See the Visual Gallery for screenshots and animated demos.

---

🚀 Why StyledConsole?

Rich is powerful, but StyledConsole adds the finishing touches:

	Feature	What It Does
🌈	Gradient Engine	Smooth rainbows and linear gradients on borders, text, banners
🎯	Smart Icons	224 icons with automatic ASCII fallback for CI/legacy terminals
📊	StyledTables	Beautiful tables with gradient borders and config-driven creation
🔧	Environment Detection	Auto-adapts for NO_COLOR, CI, TERM=dumb
🏗️	Frame Engine	8 border styles, nested frames, width alignment
📤	HTML & Image Export	Export to HTML, PNG, WebP, GIF with full emoji support
📋	Declarative Layouts	Build entire UIs from JSON/dict config

---

✨ Key Features

🎯 Smart Icon System

Policy-aware symbols with automatic ASCII fallback — works everywhere:

from styledconsole import icons

print(f"{icons.ROCKET} Deploying...")      # 🚀 in modern terminals
print(f"{icons.CHECK_MARK_BUTTON} Done!")  # ✅ or >>> in CI

Environment	Output	Rendering
Modern Terminal	🚀	Full emoji
CI / Legacy	>>>	Colored ASCII

🌈 Gradient Frames & Borders

Smooth color transitions on any frame border:

from styledconsole import Console

console = Console()
console.frame(
    "Build successful!",
    title="Status",
    border="rounded",
    border_gradient_start="green",
    border_gradient_end="cyan",
)

🔤 ASCII Art Banners

500+ fonts with integrated gradient and rainbow support:

console.banner("HELLO", font="slant", rainbow=True)
console.banner("WORLD", font="big", start_color="cyan", end_color="magenta")

📊 StyledTables

Beautiful tables with gradient borders, created from code or config:

from styledconsole.presets.tables import create_table_from_config

table = create_table_from_config(
    theme={"border_style": "heavy", "gradient": {"start": "cyan", "end": "blue"}},
    data={
        "columns": [{"header": "Service"}, {"header": "Status"}],
        "rows": [["API", "✅ Online"], ["Database", "✅ Online"]]
    }
)
console.print(table)

🔧 Environment-Aware Rendering

Automatically adapts for CI/CD pipelines and restricted terminals:

from styledconsole import Console, RenderPolicy

# CI-friendly: colors preserved, ASCII symbols
console = Console(policy=RenderPolicy.ci_friendly())

# Auto-detects: NO_COLOR, FORCE_COLOR, TERM=dumb, CI, GITHUB_ACTIONS

📤 HTML & Image Export

Record terminal sessions and export to HTML or images:

console = Console(record=True)
# ... render your UI ...

# HTML export (built-in)
console.export_html("output.html")

# Image export (pip install styledconsole[image])
console.export_png("output.png")
console.export_webp("output.webp")
console.export_gif("animation.gif")  # animated!

📋 Declarative Layouts

Build complex dashboards from JSON/dict — perfect for config-driven UIs:

from styledconsole.presets.layouts import create_layout_from_config

layout = create_layout_from_config({
    "type": "panel",
    "title": "DASHBOARD",
    "border": "heavy",
    "content": {"type": "text", "content": "Status: Online"}
})
console.print(layout)

---

🏁 Quick Start

pip install -i https://test.pypi.org/simple/ styledconsole

from styledconsole import Console, icons

console = Console()

console.frame(
    f"{icons.CHECK_MARK_BUTTON} Build successful\n"
    f"{icons.ROCKET} Deployed to production",
    title=f"{icons.SPARKLES} Status",
    border="rounded",
    border_gradient_start="green",
    border_gradient_end="cyan",
)

Output:

╭──────── ✨ Status ─────────╮
│ ✅ Build successful        │
│ 🚀 Deployed to production  │
╰────────────────────────────╯

👉 Want more examples? Check out StyledConsole-Examples for 40+ real-world demos including CLI dashboards, progress bars, error reporters, and animated effects.

---

🏗️ Built On Giants

StyledConsole extends these excellent libraries:

Library	Contribution
Rich	💪 Core rendering engine
emoji	😀 4000+ Unicode emojis
PyFiglet	🔤 500+ ASCII art fonts
wcwidth	📏 Unicode width calculation
ansi2html	💾 Terminal → HTML export

---

📊 Project Status

v0.10.3 — 🏗️ Early Access (TestPyPI)

Metric	Value
🧪 Tests	1315 passing
📊 Coverage	82%
🔍 MyPy	0 errors
🐍 Python	3.10 – 3.14

---

📚 Documentation

Resource	Description
📖 User Guide	Complete API reference
🏗️ Developer Guide	Architecture & internals
🎨 Visual Gallery	Screenshots & demos
📅 Changelog	Version history
🤝 Contributing	Development workflow

---

💙 Support

If StyledConsole improves your developer experience:

Platform	Link
💖 GitHub Sponsors	github.com/sponsors/ksokolowski
☕ Ko-fi	ko-fi.com/styledconsole

---

📄 License

Apache License 2.0 — See LICENSE for details.