./devel/py-rich-click, Format click help output nicely with rich

[ CVSweb ] [ Homepage ] [ RSS ] [ Required by ] [ Add to tracker ]


Branch: CURRENT, Version: 1.8.9, Package name: py312-rich-click-1.8.9, Maintainer: bacon

The intention of rich-click is to provide attractive help output from
click, formatted with rich, with minimal customisation required.


Master sites:

Filesize: 38.455 KB

Version history: (Expand)


CVS history: (Expand)


   2025-05-22 08:01:08 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-rich-click: updated to 1.8.9

1.8.9

Click 8.2 support:

Fix deprecation warning in Click 8.2.
Fix typing incompatibilities with Click 8.2.
Fixed no_args_is_help=True with Click 8.2:
Added Click 8.2's support for Parameter.deprecated: str | bool
   2025-04-13 09:09:56 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-rich-click: updated to 1.8.8

Version 1.8.8 (2025-03-09)

Make text wrap instead of using ellipses for overflowing metavars in options tables.
Added --errors-in-output-format flag to rich-click CLI.
Actually fixed regression in stderr handling

Version 1.8.7 (2025-03-08)

Add ability to turn off option/command deduplication in groups
Fix regression in stderr handling

Version 1.8.6 (2025-02-19)

Fix incompatibility with click 8.2.0.

Version 1.8.5 (2024-12-01)

Fix issue with error messages not using user-defined styles.

Version 1.8.4 (2024-11-12)

Support rich.text.Text() objects for header_text, footer_text, \ 
errors_suggestion, and errors_epilogue.

Version 1.8.3 (2023-06-09)

Support {cmd} as an option/command group key when python -m {cmd} is the \ 
command_path.
Fix yet another deprecation warning issue. (Sorry, sorry.)

Version 1.8.2 (2023-05-14)

Fix another deprecation warning issue.

Version 1.8.1 (2023-05-07)

Fixed bad deprecation warning with highlighter
Fixed incompatibility with Click 9.

Version 1.8.0 (2023-04-30)

Add --rich-config and --output options to the rich-click CLI.
Lazy load Rich to reduce overhead when not rendering help text.
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:
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
Added panel_styles support to groups.
Allow table_styles and panel_styles to be defined for the positional arguments group.
   2025-03-06 02:19:07 by Jason Bacon | Files touched by this commit (44)
Log message:
Multiple packages: OWNER -> MAINTAINER
   2023-07-24 06:46:23 by Adam Ciarcinski | Files touched by this commit (1)
Log message:
py-rich-click: add ALTERNATIVES
   2023-07-24 06:45:33 by Adam Ciarcinski | Files touched by this commit (2)
Log message:
py-rich-click: package properly
   2023-07-23 04:09:54 by Thomas Klausner | Files touched by this commit (1)
Log message:
py-rich-click: not for Python 2
   2023-07-23 04:09:36 by Thomas Klausner | Files touched by this commit (1)
Log message:
py-rich-click: fix DEPENDS
   2023-07-20 16:23:56 by Jason Bacon | Files touched by this commit (4)
Log message:
devel/py-rich-click: Format click output with rich

The intention of rich-click is to provide attractive help output from
click, formatted with rich, with minimal customisation required.