Rich Click Versions Save

Format click help output nicely with rich.

v1.8.2

4 days ago
  • Fix another deprecation warning issue.

v1.8.1

1 week ago
  • Fixed bad deprecation warning with highlighter
  • Fixed incompatibility with Click 9.

v1.8.0

2 weeks ago
  • Add --rich-config and --output options to the rich-click CLI.
  • Lazy load Rich to reduce overhead when not rendering help text. [#154]
  • Some internal refactors. These refactors are aimed at making the abstractions more maintainable over time, more consistent, and more adept for advanced used cases.
    • rich_click.py is exclusively the global config; all formatting has been moved to rich_help_rendering.py.
    • RichCommand now makes use of methods in the super class: format_usage, format_help_text, format_options, and format_epilog.
    • Global formatter object has been removed from the code.
    • highlighter is now constructed by the RichHelpFormatter rather than being inside the config object.
  • Added RichHelpConfiguration.load_from_globals() classmethod, which pulls all configuration from rich_click.py.
  • Fix bug with regex highlighter for options and switches.
  • RichHelpConfiguration() is now asserted to be JSON serializable, as an option for porting configurations. That said, serialization is not a fully supported feature of the high-level API, so serialize the config at your own risk.
    • Related: highlighter is now deprecated in RichHelpConfiguration; please use highlighter_patterns instead.
  • Moved exclusively to pyproject.toml and removed setup.py / setup.cfg; thank you @Stealthii!
  • Moved to text_markup: Literal["markdown", "rich", "ansi", None] instead of booleans.
    • The default is now ansi instead of None to help support usage of click.style(). None is still supported.
  • Fixed issue where error messages would not print to stderr by default.
  • New configuration options: [#178]
    • STYLE_OPTIONS_PANEL_BOX
    • STYLE_COMMANDS_PANEL_BOX
    • STYLE_ERRORS_PANEL_BOX
  • Many quality of life improvements for command and option groups:
    • Support both command_path and command.name.
    • Added wildcard (*) option for command groups and option groups, with thanks to @ITProKyle!
    • Resolve duplicates.
    • Better typing for option groups and command groups with TypedDict [#156]
    • Added panel_styles support to groups. [#178]
    • Allow table_styles and panel_styles to be defined for the positional arguments group.

v1.8.0dev7

3 weeks ago

Using __version__ instead of importlib for the Click version check vastly improves performance.

v1.8.0dev6

1 month ago
  • Significant improvements to styling for panels.

v1.8.0dev5

1 month ago
  • Some quality of life improvements for command and option groups:
    • Support both ctx.command_path and command.name
    • Added wildcard (*) option for command groups and option groups, with thanks to @ITProKyle!
    • Resolve duplicates.

v1.8.0dev4

1 month ago
  • Mistake

v1.8.0dev3

1 month ago
  • Fixed issue where error messages would not print to stderr by default.

v1.8.0dev2

1 month ago
  • World's most esoteric bug fixed.

v1.8.0dev1

1 month ago
  • Bugfix to rich_click.patch.patch() behavior when running unpatched RichGroups.