rich

General Guidelines

• Adhere to PEP 8 coding style guidelines for Python code, emphasizing readability and consistency.
• Limit lines to a maximum of 79 characters to enhance readability across different environments.
• Prioritize code clarity and simplicity, making it easy to understand and maintain.
• Use UTF-8 encoding for source files to ensure compatibility with a wide range of characters.

Installation and Environment

• Use uv for installing dependencies to improve speed and reliability, if appropriate.
• Specify Python 3.12 or later to leverage the latest language features and performance improvements. (If applicable for the specific features of rich you are using)

Code Organization and Structure

• Directory Structure: Follow a logical directory structure.

  project_root/ ├── src/ │ ├── main.py # Entry point of the application │ ├── utils/ │ │ ├── init.py │ │ ├── helper_functions.py │ ├── modules/ │ │ ├── init.py │ │ ├── module_a.py # Rich-related components │ │ ├── module_b.py ├── tests/ │ ├── init.py │ ├── test_main.py │ ├── test_module_a.py ├── README.md ├── pyproject.toml # Or requirements.txt

• File Naming: Use descriptive lowercase names with underscores (e.g., console_output.py).

• Module Organization: Group related functionalities into separate modules (e.g., rich_display.py, data_formatting.py).

• Component Architecture: Design modular components with clear interfaces for reusability and maintainability.

• Code Splitting: Break down large files into smaller, more manageable pieces based on functionality. Consider lazy loading of less-frequently used modules.

Coding Style and Best Practices

• Indentation: Use 4 spaces for indentation.
• Blank Lines: Separate top-level functions and classes with two blank lines, and methods within a class with one blank line.
• Imports:
  • Group imports in the following order:
    1. Standard library imports
    2. Third-party library imports (including Rich)
    3. Local application imports
  • Use absolute imports for clarity, unless relative imports significantly improve readability within a package.
  • Avoid wildcard imports (from module import *).
• Naming Conventions:
  • Use lowercase with underscores for function and variable names (my_variable, my_function).
  • Use CapWords for class names (MyClass).
  • Use UPPER_CASE_WITH_UNDERSCORES for constants (MAX_VALUE).
• String Quotes: Use double quotes consistently for strings, especially for docstrings.

Rich Library Specific Best Practices

• Console Instantiation: Create a single Console instance for your application and reuse it throughout. python from rich.console import Console

  console = Console()

  def my_function(): console.print("Hello, [bold red]World![/bold red]")

• Styling: Use Rich's markup system for styling text. Refer to the Rich documentation for available styles and their usage. python console.print("[link=https://example.com]Click here[/link] to visit example.com")

• Tables: Utilize the Table class for structured data display. Configure columns and rows appropriately. python from rich.table import Table

  table = Table(title="My Data") table.add_column("Name", style="cyan", no_wrap=True) table.add_column("Age", style="magenta") table.add_row("Alice", "30") table.add_row("Bob", "25") console.print(table)

• Progress Bars: Employ the Progress class for tracking long-running tasks. Configure the progress bar to accurately reflect the task's progress. python from rich.progress import Progress import time

  with Progress() as progress: task1 = progress.add_task("[red]Downloading...", total=1000) task2 = progress.add_task("[green]Processing...", total=100)