Skip to content

Releases: ewels/rich-click

v1.8.4

13 Nov 15:58
1f3b970
Compare
Choose a tag to compare
  • Support rich.text.Text() objects for header_text, footer_text, errors_suggestion, and errors_epilogue.

v1.8.3

10 Jun 02:34
edddc19
Compare
Choose a tag to compare
  • Support {cmd} as an option/command group key when python -m {cmd} is the command_path.
  • Fix yet another deprecation warning issue. (Sorry, sorry.)

v1.8.2

14 May 12:43
7662593
Compare
Choose a tag to compare
  • Fix another deprecation warning issue.

v1.8.1

07 May 13:04
bcd77f1
Compare
Choose a tag to compare
  • Fixed bad deprecation warning with highlighter
  • Fixed incompatibility with Click 9.

v1.8.0

30 Apr 02:37
64cf966
Compare
Choose a tag to compare
  • 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

24 Apr 02:31
Compare
Choose a tag to compare
v1.8.0dev7 Pre-release
Pre-release

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

v1.8.0dev6

14 Apr 16:02
cfd41c6
Compare
Choose a tag to compare
v1.8.0dev6 Pre-release
Pre-release
  • Significant improvements to styling for panels.

v1.8.0dev5

13 Apr 22:29
Compare
Choose a tag to compare
v1.8.0dev5 Pre-release
Pre-release
  • 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

11 Apr 00:46
Compare
Choose a tag to compare
v1.8.0dev4 Pre-release
Pre-release
  • Mistake

v1.8.0dev3

11 Apr 00:35
Compare
Choose a tag to compare
v1.8.0dev3 Pre-release
Pre-release
  • Fixed issue where error messages would not print to stderr by default.