Vargula Documentation

Welcome to the official documentation for Vargula.

Contents:

• Why Vargula?
  • Overview
  • Quick Comparison Table
  • Side-by-Side: “Hello World” Example
  • Comparison Summary
  • vs. Rich
  • vs. Colorama
  • vs. Termcolor
  • vs. Pastel
  • Vargula’s Unique Strengths
  • When to Choose Vargula
  • Complementary Usage
  • Maturity & Community
  • Real-World Complex Example
  • The Verdict
  • Conclusion
• Installation
  • Requirements
  • Install from PyPI
  • Install from Source
  • Verify Installation
  • Platform-Specific Notes
  • Dependencies
  • Virtual Environment (Recommended)
  • Development Installation
  • Uninstallation
  • Troubleshooting
  • Next Steps
• Conventions
  • Tag Syntax Conventions
• Vargula API
  • API Reference
• In-built Resources
• Color Scheme Reference
  • Monochromatic
  • Analogous
  • Complementary
  • Split Complementary
  • Triadic
  • Tetradic
  • Square
• WCAG Contrast Guidelines
• Environment Variables
• Examples
  • Example 1: Color Palette Explorer
  • Example 2: Themed CLI Application
  • Example 3: Accessible Theme Generator
  • Example 4: Data Table with Styling
  • Example 5: Multi-Progress Task Manager
  • Example 6: Color Manipulation
  • Example 7: Colorblind Simulation
• Tips & Best Practices
  • 1. Use Themes for Consistency
  • 2. Test Accessibility Early
  • 3. Validate for Colorblindness
  • 4. Save and Reuse Palettes
  • 5. Nest Styles for Complex Formatting
• Appendix
  • Quick Reference
  • Color Theory Guide
  • WCAG Compliance Guide
  • Performance Tips
  • Troubleshooting
  • Migration Guide
  • Additional Resources
  • Version Compatibility
• Quick Reference
  • Instance Creation
  • Core Styling Functions
  • Theme Functions
  • Table Functions
  • Progress Bar Functions
  • Color Palette Generation
  • Color Manipulation Functions
  • Accessibility Functions
  • Color Blindness Functions
  • Persistence Functions
  • Function Categories
  • Alphabetical Index
  • Common Workflows
  • Quick Start Examples
  • Parameter Quick Reference
  • Return Type Quick Reference
• Frequently Asked Questions
  • Installation & Setup
  • Color & Styling
  • Comparison with Other Libraries
  • Troubleshooting
  • More Questions?

Simple cross-platform terminal text styling library with advanced color palette generation

Vargula is a powerful Python library for terminal styling that combines better functionality with comprehensive color theory tools. Style your terminal output with colors, create beautiful tables, show progress bars, and generate harmonious color palettes - all with a simple, intuitive API.

Try this Vargula’s code snippet to run this:

What’s new?

BREAKING CHANGES

• API Restructured to Class-Based Design: Major refactoring for better organization and thread-safety

  • All functionality now accessed through Vargula class instances

  • Removed module-level global functions (global state eliminated)

  • Each instance maintains independent state for thread-safe operations

Refer the API Reference section to know more.

Features

• Text Styling: Colors, backgrounds, and text decorations (bold, italic, underline, etc.)

• Markup Syntax: HTML-like tags for inline styling (<red>error</red>)

• Tables: Rich-style tables with customizable borders and styling

• Progress Bars: Customizable progress indicators with ETA and rate display

• Color Palettes: Generate harmonious color schemes based on color theory

• Accessibility: WCAG contrast checking and colorblind simulation

• Themes: Built-in themes and custom theme support

• Cross-platform: Works on Windows, macOS, and Linux