Vargula Logo

Contents:

  • Why Vargula?
    • Overview
    • Quick Comparison Table
    • Side-by-Side: “Hello World” Example
      • Vargula
      • Rich
      • Colorama
      • Termcolor
      • Pastel
    • Comparison Summary
      • Code Clarity (Best to Worst)
      • Readability Score
      • Character Count Comparison
      • Complex Nesting Example
        • Vargula
        • Rich
        • Pastel
        • Termcolor
        • Colorama
      • Winner by Category
    • vs. Rich
      • Where Rich Excels
      • Where Vargula Excels
      • When to Choose Each
      • Example Comparison
    • vs. Colorama
      • Where Colorama Excels
      • Where Vargula Excels
      • When to Choose Each
      • Example Comparison
    • vs. Termcolor
      • Where Termcolor Excels
      • Where Vargula Excels
      • When to Choose Each
      • Example Comparison
    • vs. Pastel
      • Where Pastel Excels
      • Where Vargula Excels
      • When to Choose Each
      • Example Comparison
    • Vargula’s Unique Strengths
      • 1. Color Theory Integration
      • 2. Accessibility First
      • 3. Intuitive Background Color Syntax
      • 4. Complete Color Manipulation Toolkit
      • 5. Palette Persistence
    • When to Choose Vargula
      • Perfect For:
      • May Not Be Ideal For:
    • Complementary Usage
    • Maturity & Community
    • Real-World Complex Example
      • Vargula
      • Rich
      • Termcolor
      • Colorama
    • The Verdict
      • Choose Rich if you need:
      • Choose Colorama if you need:
      • Choose Termcolor if you need:
      • Choose Pastel if you need:
      • Choose Vargula if you need:
    • Conclusion
  • Installation
    • Requirements
    • Install from PyPI
      • Upgrade to Latest Version
      • Install Specific Version
    • Install from Source
    • Verify Installation
    • Platform-Specific Notes
      • Windows
      • macOS
      • Linux
    • Dependencies
    • Virtual Environment (Recommended)
    • Development Installation
    • Uninstallation
    • Troubleshooting
      • Colors Not Showing
      • Windows ANSI Issues
      • Import Errors
    • Next Steps
  • Conventions
    • Tag Syntax Conventions
      • Examples
      • Tag Format Rules
      • Available Named Colors
  • Vargula API
    • API Reference
      • Creating Instances
        • Instance-Based API (Recommended for Applications)
        • Thread-Safe Operations
      • Core Styling Functions
        • style(text, color=None, bg=None, look=None)
        • format(text)
        • create(name, color=None, bg=None, look=None)
        • delete(name)
        • write(*args, sep=" ", end="\n", file=None, flush=False)
        • strip(text)
        • clean(text)
        • length(text)
        • enable() / disable()
        • temporary(name, color=None, bg=None, look=None)
      • Theme Functions
        • set_theme(theme)
      • Tables
        • Table(title=None, caption=None, ...)
        • Table.add_column(header, style=None, justify="left", ...)
        • Table.add_row(*cells, style=None)
      • Progress Bars
        • ProgressBar(total=100, desc="", ...)
        • ProgressBar.update(n=1)
        • ProgressBar.close()
        • progress_bar(iterable, total=None, desc="", **kwargs)
        • MultiProgress()
        • MultiProgress.add_task(desc, total=100, **kwargs)
        • MultiProgress.update(task_id, n=1)
      • Color Palette Generation
        • generate_palette(base_color=None, scheme="random", count=5, ...)
        • generate_theme_palette(scheme="random", base_color=None, ...)
        • generate_accessible_theme(base_color, scheme="complementary", ...)
        • preview_palette(colors, width=40, show_info=True)
        • apply_palette_theme(palette, register_styles=True)
      • Color Manipulation
        • lighten(color, amount=0.1)
        • darken(color, amount=0.1)
        • saturate(color, amount=0.1)
        • desaturate(color, amount=0.1)
        • shift_hue(color, degrees)
        • invert(color)
        • mix(color1, color2, weight=0.5)
      • Accessibility Functions
        • calculate_contrast_ratio(color1, color2)
        • meets_wcag(color1, color2, level="AA", large_text=False)
        • ensure_contrast(foreground, background, min_ratio=4.5, max_iterations=20)
      • Color Blindness Functions
        • simulate_colorblindness(hex_color, cb_type)
        • validate_colorblind_safety(colors, cb_type="deuteranopia", min_difference=30)
      • Persistence Functions
        • save_palette(colors, filename, metadata=None)
        • load_palette(filename)
        • save_theme(theme, filename, metadata=None)
        • load_theme(filename)
  • 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 Name Cheat Sheet
      • Text Decoration Cheat Sheet
      • Box Style Cheat Sheet
      • Color Harmony Schemes
    • Color Theory Guide
      • Understanding Color Spaces
      • Color Wheel Relationships
      • Practical Color Selection
    • WCAG Compliance Guide
      • Contrast Ratio Requirements
      • Testing Color Combinations
      • Automatic Compliance
      • Color Blindness Considerations
    • Performance Tips
      • Minimize Redundant Formatting
      • Batch Operations
      • Disable Styling When Not Needed
      • Efficient Progress Bars
    • Troubleshooting
      • Colors Not Displaying
      • Layout Issues with Tables
      • Progress Bar Flickering
      • Memory Issues with Large Outputs
      • Style Conflicts
    • Migration Guide
      • From Print Statements
      • From Manual ANSI Codes
      • From Other Styling Libraries
      • Best Practices for Migration
    • Additional Resources
      • Example Projects
      • Color Palette Generators
      • Community Themes
    • 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
      • By Use Case
    • Alphabetical Index
    • Common Workflows
      • Basic Text Styling
      • Custom Style System
      • Theme Creation
      • Accessible Design
      • Data Visualization
      • Progress Tracking
    • Quick Start Examples
      • Styling Text
      • Creating Tables
      • Progress Bars
      • Color Palettes
    • Parameter Quick Reference
      • Common Parameters
    • Return Type Quick Reference
  • Frequently Asked Questions
    • Installation & Setup
      • Q: How do I install Vargula?
      • Q: What Python versions are supported?
      • Q: Does Vargula work on Windows?
    • Color & Styling
      • Q: How do I create accessible color palettes?
      • Q: Can I validate colors for colorblind users?
      • Q: What color schemes are available?
    • Comparison with Other Libraries
      • Q: How is Vargula different from Rich?
      • Q: Should I use Vargula or Colorama?
    • Troubleshooting
      • Q: Colors aren’t showing in my terminal
      • Q: How do I disable colors temporarily?
      • Q: My custom theme isn’t working
    • More Questions?
Vargula
  • Search

© Copyright 2025, Sivaprasad Murali. Last updated on Jan 16, 2026.

Built with Sphinx using a theme provided by Read the Docs.