Welcome to ascii_colors’s Documentation! 🎨

Tired of bland terminal output? Need powerful logging without the boilerplate? ASCIIColors is your Python solution for vibrant terminal applications!

It elegantly combines:

• ✨ Effortless Color Printing: Directly output text with a wide range of ANSI colors and styles using simple, intuitive methods.

• 🪵 Flexible Logging System: A robust, leveled logging framework with handlers, formatters, and context management.

• 🐍 `logging` Compatibility: Features a familiar API (import ascii_colors as logging) for seamless integration or transition from Python’s standard logging module.

• 🛠️ Handy Utilities: Includes useful tools like console spinners and text highlighting.

Whether you’re building CLI tools, backend services, or just want more informative script output, ASCIIColors makes your terminal interactions clearer and more expressive.

Note

For a quick overview and installation instructions, you can also check the README file on GitHub.

User Guide

• Quick Start
  • Option 1: Logging (Recommended)
  • Option 2: Direct Printing
• Usage Guide
  • Core Concepts: Direct Print vs. Logging
  • Using the Logging Compatibility Layer (import ascii_colors as logging)
  • Available Colors and Styles (for Direct Printing)
  • Direct Printing Examples
  • Logging System Examples
  • Context Management
  • Utilities

Reference

• API Reference
  • Core Class: ASCIIColors
  • Logging Compatibility API
  • Handler Classes
  • Formatter Classes
  • Utility Functions

Indices and tables

• Index

• Module Index

• Search Page