rich-click

• Fix click_version check when build metadata is included. [#324] (@ccoulombe)

• Fix minor Typer incompatibilities, most notably default panel placements.
• Added default_panels_first config option which places default panels above user-defined panels.
• Fix to .pyi file [#319] (@nemowang2003)

• Fix no_args_is_help for Typer CLIs. [#313]
• Fix strange encoding issue on Windows in GH Actions [#314]

• Fix no_args_is_help for Typer CLIs. [#313]
• Fix strange encoding issue on Windows in GH Actions [#314]

• Added Typer 0.20 support
• Fix lack of support for flag_value=....

• Fixed subcommand discovery in help text. Behavior should now be the same as 1.8. [#304]

• Fixed subcommand discovery in help text. Behavior should now be the same as 1.8. [#304]

• Fixed legacy Windows rendering
• Fix issue with parent click.Group and child rich_click.RichCommand error formatter not resolving.
• Add headers to tables (by default these are not shown).

• Fixed legacy windows rendering
• Fix issue with parent click.Group and child rich_click.RichCommand error formatter not resolving.
• Add headers to tables (by default these are not shown).

• Fixed bug where running the rich-click CLI on a @rich_click.argument() sometimes caused arguments show up in the option panel when it shouldn't.
• Slightly reduced horizontal padding of the modern theme format.
• Fixed Click 8.3 compatibility with rendering defaults in help text.

[!WARNING] Version 1.9.0 deprecates support for a lot of old versions of things:

• Python 3.7 support is removed. The minimum supported Python version is 3.8.
• Click 7 support is removed. The minimum supported Click version is 8.0.
• Rich 10 and 11 support is removed. The minimum supported Rich version is 12.

[!WARNING] Version 1.9.0 introduces a minor breaking change: The DEFAULT_STRING, ENVVAR_STRING, REQUIRED_STRING, and DEPRECATED_STRING config options are now rendered with Text.from_markup. So for example, REQUIRED_STRING = "[required]" would be rendered as Rich markup. You must now escape the rich markup: REQUIRED_STRING = "\\[required]"

Big changes:

• Themes! Check them out with rich-click --themes.
• Typer support: rich-click typer_app --help.
• RichPanels API introduced. This replaces the "groups" feature going forward (although groups will continue to be supported).
  • @click.option_panel()
  • @click.command_panel()
• IDE tab completion support for decorators. Now you should no longer need to guess what goes in @click.option() or @click.command(context_settings=...) etc.
• Help for arguments: help= is now a valid kwarg for @click.argument() decorator. See docs for more information.

Small changes:

• "Deprecated" text properly handled and stylized in all places.
• Command aliases: @cli.command(aliases=["foo"])
• Improved rich-click CLI usability: improved patching and improved script detection+execution.
• context_settings={"help_to_stderr": True} support.
• Added suite of padding_* config options to control padding.
  • Better newline handling:
    • Unordered lists create newlines in help text, e.g. "\n- foo\n- bar" or "\n* foo\n* bar"
    • Newline control in help text with text_paragraph_linebreaks config option.
• Added a few text_* config options, including notably text_kwargs which can control code styles in Markdown.

Backend (mostly invisible) changes:

• Overhauled our test suite to use inline-snapshot! 😁
• Improved test coverage and CI.
• typing_extensions now only required for < Python 3.11.
• RichHelpFormatter now defers printing by default if a user does not specify a Console. [#231] (With contributions from @ofek)
  • This more closely aligns the RichHelpFormatter with how base Click works.
• Significant refactors to help text rendering.
• Reintroduced deprecation warnings for a couple of features deprecated in 1.8.
• There was an issue where the rich.highlighter module could load during CLI execution. We now assert in unit-tests that no rich modules are loaded during code execution, so going forward, rich imports should no longer ever be a side-effect of CLI execution.

[!WARNING] Version 1.9.0 deprecates support for a lot of old versions of things:

• Python 3.7 support is removed. The minimum supported Python version is 3.8.
• Click 7 support is removed. The minimum supported Click version is 8.0.
• Rich 10 and 11 support is removed. The minimum supported Rich version is 12.

[!WARNING] Version 1.9.0 introduces a minor breaking change: The DEFAULT_STRING, ENVVAR_STRING, REQUIRED_STRING, and DEPRECATED_STRING config options are now rendered with Text.from_markup. So for example, REQUIRED_STRING = "[required]" would be rendered as Rich markup. You must now escape the rich markup: REQUIRED_STRING = "\\[required]"

Big changes:

• Themes! Check them out with rich-click --themes.
• Typer support: rich-click typer_app --help.
• RichPanels API introduced. This replaces the "groups" feature going forward (although groups will continue to be supported).
  • @click.option_panel()
  • @click.command_panel()
• IDE tab completion support for decorators. Now you should no longer need to guess what goes in @click.option() or @click.command(context_settings=...) etc.
• Help for arguments: help= is now a valid kwarg for @click.argument() decorator. See docs for more information.

Small changes:

• "Deprecated" text properly handled and stylized in all places.
• Command aliases: @cli.command(aliases=["foo"])
• Improved rich-click CLI usability: improved patching and improved script detection+execution.
• context_settings={"help_to_stderr": True} support.
• Added suite of padding_* config options to control padding.
  • Better newline handling:
    • Unordered lists create newlines in help text, e.g. "\n- foo\n- bar" or "\n* foo\n* bar"
    • Newline control in help text with text_paragraph_linebreaks config option.
• Added a few text_* config options, including notably text_kwargs which can control code styles in Markdown.

Backend (mostly invisible) changes:

• Overhauled our test suite to use inline-snapshot! 😁
• Improved test coverage and CI.
• typing_extensions now only required for < Python 3.11.
• RichHelpFormatter now defers printing by default if a user does not specify a Console. [#231] (With contributions from @ofek)
  • This more closely aligns the RichHelpFormatter with how base Click works.
• Significant refactors to help text rendering.
• Reintroduced deprecation warnings for a couple of features deprecated in 1.8.
• There was an issue where the rich.highlighter module could load during CLI execution. We now assert in unit-tests that no rich modules are loaded during code execution, so going forward, rich imports should no longer ever be a side-effect of CLI execution.

[!WARNING] Version 1.9.0 deprecates support for a lot of old versions of things:

• Python 3.7 support is removed. The minimum supported Python version is 3.8.
• Click 7 support is removed. The minimum supported Click version is 8.0.
• Rich 10 and 11 support is removed. The minimum supported Rich version is 12.

[!WARNING] Version 1.9.0 introduces a minor breaking change: The DEFAULT_STRING, ENVVAR_STRING, REQUIRED_STRING, and DEPRECATED_STRING config options are now rendered with Text.from_markup. So for example, REQUIRED_STRING = "[required]" would be rendered as Rich markup. You must now escape the rich markup: REQUIRED_STRING = "\\[required]"

Big changes:

• Themes! Check them out with rich-click --themes.
• Typer support: rich-click typer_app --help.
• RichPanels API introduced. This replaces the "groups" feature going forward (although groups will continue to be supported).
  • @click.option_panel()
  • @click.command_panel()
• IDE tab completion support for decorators. Now you should no longer need to guess what goes in @click.option() or @click.command(context_settings=...) etc.
• Help for arguments: help= is now a valid kwarg for @click.argument() decorator. See docs for more information.

Small changes:

• "Deprecated" text properly handled and stylized in all places.
• Command aliases: @cli.command(aliases=["foo"])
• Improved rich-click CLI usability: improved patching and improved script detection+execution.
• context_settings={"help_to_stderr": True} support.
• Added suite of padding_* config options to control padding.
  • Better newline handling:
    • Unordered lists create newlines in help text, e.g. "\n- foo\n- bar" or "\n* foo\n* bar"
    • Newline control in help text with text_paragraph_linebreaks config option.
• Added a few text_* config options, including notably text_kwargs which can control code styles in Markdown.

Backend (mostly invisible) changes:

• Overhauled our test suite to use inline-snapshot! 😁
• Improved test coverage and CI.
• typing_extensions now only required for < Python 3.11.
• RichHelpFormatter now defers printing by default if a user does not specify a Console. [#231] (With contributions from @ofek)
  • This more closely aligns the RichHelpFormatter with how base Click works.
• Significant refactors to help text rendering.
• Reintroduced deprecation warnings for a couple of features deprecated in 1.8.
• There was an issue where the rich.highlighter module could load during CLI execution. We now assert in unit-tests that no rich modules are loaded during code execution, so going forward, rich imports should no longer ever be a side-effect of CLI execution.

[!WARNING] Version 1.9.0 deprecates support for a lot of old versions of things:

• Python 3.7 support is removed. The minimum supported Python version is 3.8.
• Click 7 support is removed. The minimum supported Click version is 8.0.
• Rich 10 and 11 support is removed. The minimum supported Rich version is 12.

[!WARNING] Version 1.9.0 introduces a minor breaking change: The DEFAULT_STRING, ENVVAR_STRING, REQUIRED_STRING, and DEPRECATED_STRING config options are now rendered with Text.from_markup. So for example, REQUIRED_STRING = "[required]" would be rendered as Rich markup. You must now escape the rich markup: REQUIRED_STRING = "\\[required]"

Big changes:

• Themes! Check them out with rich-click --themes.
• RichPanels API introduced. This replaces the "groups" feature going forward (although groups will continue to be supported).
  • @click.option_panel()
  • @click.command_panel()
• IDE tab completion support for decorators. Now you should no longer need to guess what goes in @click.option() or @click.command(context_settings=...) etc.
• Help for arguments: help= is now a valid kwarg for @click.argument() decorator. See docs for more information.

Small changes:

• "Deprecated" text properly handled and stylized in all places.
• Command aliases: @cli.command(aliases=["foo"])
• Improved rich-click CLI usability: improved patching and improved script detection+execution.
• context_settings={"help_to_stderr": True} support.
• Added suite of padding_* config options to control padding.
  • Better newline handling:
    • Unordered lists create newlines in help text, e.g. "\n- foo\n- bar" or "\n* foo\n* bar"
    • Newline control in help text with text_paragraph_linebreaks config option.
• Added a few text_* config options, including notably text_kwargs which can control code styles in Markdown.

Backend (mostly invisible) changes:

• Overhauled our test suite to use inline-snapshot! 😁
• Improved test coverage and CI.
• typing_extensions now only required for < Python 3.11.
• RichHelpFormatter now defers printing by default if a user does not specify a Console. [#231] (With contributions from @ofek)
  • This more closely aligns the RichHelpFormatter with how base Click works.
• Significant refactors to help text rendering.
• Reintroduced deprecation warnings for a couple of features deprecated in 1.8.
• There was an issue where the rich.highlighter module could load during CLI execution. We now assert in unit-tests that no rich modules are loaded during code execution, so going forward, rich imports should no longer ever be a side-effect of CLI execution.

[!WARNING] Version 1.9.0 deprecates support for a lot of old versions of things:

• Python 3.7 support is removed. The minimum supported Python version is 3.8.
• Click 7 support is removed. The minimum supported Click version is 8.0.
• Rich 10 and 11 support is removed. The minimum supported Rich version is 12.

[!WARNING] Version 1.9.0 introduces a minor breaking change: The DEFAULT_STRING, ENVVAR_STRING, REQUIRED_STRING, and DEPRECATED_STRING config options are now rendered with Text.from_markup. So for example, REQUIRED_STRING = "[required]" would be rendered as Rich markup. You must now escape the rich markup: REQUIRED_STRING = "\\[required]"

Big changes:

• Themes! Check them out with rich-click --themes.
• RichPanels API introduced. This replaces the "groups" feature going forward (although groups will continue to be supported).
  • @click.option_panel()
  • @click.command_panel()
• IDE tab completion support for decorators. Now you should no longer need to guess what goes in @click.option() or @click.command(context_settings=...) etc.
• Help for arguments: help= is now a valid kwarg for @click.argument() decorator. See docs for more information.

Small changes:

• "Deprecated" text properly handled and stylized in all places.
• Command aliases: @cli.command(aliases=["foo"])
• Improved rich-click CLI usability: improved patching and improved script detection+execution.
• context_settings={"help_to_stderr": True} support.
• Added suite of padding_* config options to control padding.
  • Better newline handling:
    • Unordered lists create newlines in help text, e.g. "\n- foo\n- bar" or "\n* foo\n* bar"
    • Newline control in help text with text_paragraph_linebreaks config option.
• Added a few text_* config options, including notably text_kwargs which can control code styles in Markdown.

Backend (mostly invisible) changes:

• Overhauled our test suite to use inline-snapshot! 😁
• Improved test coverage and CI.
• typing_extensions now only required for < Python 3.11.
• RichHelpFormatter now defers printing by default if a user does not specify a Console. [#231] (With contributions from @ofek)
  • This more closely aligns the RichHelpFormatter with how base Click works.
• Significant refactors to help text rendering.
• Reintroduced deprecation warnings for a couple of features deprecated in 1.8.
• There was an issue where the rich.highlighter module could load during CLI execution. We now assert in unit-tests that no rich modules are loaded during code execution, so going forward, rich imports should no longer ever be a side-effect of CLI execution.

Version 1.9.0.dev2 (WIP)

[!WARNING] Version 1.9.0 deprecates support for a lot of old versions of things:

• Python 3.7 support is removed. The minimum supported Python version is 3.8.
• Click 7 support is removed. The minimum supported Click version is 8.0.
• Rich 10 and 11 support is removed. The minimum supported Rich version is 12.

[!WARNING] Version 1.9.0 introduces a minor breaking change: The DEFAULT_STRING, ENVVAR_STRING, REQUIRED_STRING, and DEPRECATED_STRING config options are now rendered with Text.from_markup. So for example, REQUIRED_STRING = "[required]" would be rendered as Rich markup. You must now escape the rich markup: REQUIRED_STRING = "\\[required]"

Big changes:

• Themes! Check them out with rich-click --themes.
• RichPanels API introduced. This replaces the "groups" feature going forward (although groups will continue to be supported).
  • @click.option_panel()
  • @click.command_panel()
• IDE tab completion support for decorators. Now you should no longer need to guess what goes in @click.option() or @click.command(context_settings=...) etc.
• Help for arguments: help= is now a valid kwarg for @click.argument() decorator. See docs for more information.

Small changes:

• "Deprecated" text properly handled and stylized in all places.
• Command aliases: @cli.command(aliases=["foo"])
• Improved rich-click CLI usability: improved patching and improved script detection+execution.
• context_settings={"help_to_stderr": True} support.
• Added suite of padding_* config options to control padding.
• Added newline control in help text with text_paragraph_linebreaks config option.
• Added a few text_* config options, including notably text_kwargs which can control code styles in Markdown.

Backend (mostly invisible) changes:

• Overhauled our test suite to use inline-snapshot! 😁
• Improved test coverage and CI.
• typing_extensions now only required for < Python 3.11.
• RichHelpFormatter now defers printing by default if a user does not specify a Console. [#231] (With contributions from @ofek)
  • This more closely aligns the RichHelpFormatter with how base Click works.
• Significant refactors to help text rendering.
• Reintroduced deprecation warnings for a couple of features deprecated in 1.8.
• There was an issue where the rich.highlighter module could load during CLI execution. We now assert in unit-tests that no rich modules are loaded during code execution, so going forward, rich imports should no longer ever be a side-effect of CLI execution.

Version 1.9.0.dev1 (WIP)

[!WARNING] Version 1.9.0 deprecates support for a lot of old versions of things:

• Python 3.7 support is removed. The minimum supported Python version is 3.8.
• Click 7 support is removed. The minimum supported Click version is 8.0.
• Rich 10 and 11 support is removed. The minimum supported Rich version is 12.

Big changes:

• Themes! Check them out with rich-click --themes.
• RichPanels API introduced. This replaces the "groups" feature going forward (although groups will continue to be supported).
  • @click.option_panel()
  • @click.command_panel()
• IDE tab completion support for decorators. Now you should no longer need to guess what goes in @click.option() or @click.command(context_settings=...) etc.
• Help for arguments: help= is now a valid kwarg for @click.argument() decorator. See docs for more information.

Small changes:

• "Deprecated" text properly handled and stylized in all places.
• Improved rich-click CLI patching.
• context_settings={"help_to_stderr": True} support.
• Added suite of padding_* config options to control padding.
• Added newline control in help text with text_paragraph_linebreaks config option.
• Added a few text_* config options, including notably text_kwargs which can control code styles in Markdown.

Backend (mostly invisible) changes:

• Overhauled our test suite to use inline-snapshot! 😁
• Improved test coverage and CI.
• typing_extensions now only required for < Python 3.11.
• RichHelpFormatter now defers printing by default if a user does not specify a Console. [#231] (With contributions from @ofek)
  • This more closely aligns the RichHelpFormatter with how base Click works.
• Significant refactors to help text rendering.
• Reintroduced deprecation warnings for a couple of features deprecated in 1.8.
• There was an issue where the rich.highlighter module could load during CLI execution. We now assert in unit-tests that no rich modules are loaded during code execution, so going forward, rich imports should no longer ever be a side-effect of CLI execution.

Version 1.9.0dev0 (WIP)

[!WARNING] Version 1.9.0 deprecates support for a lot of old versions of things:

• Python 3.7 support is removed. The minimum supported Python version is 3.8.
• Click 7 support is removed. The minimum supported Click version is 8.0.
• Rich 10 and 11 support is removed. The minimum supported Rich version is 12.

Big changes:

• RichPanels API introduced. This replaces the "groups" feature going forward (although groups will continue to be supported).
  • @click.option_panel()
  • @click.command_panel()
• help= is now a valid kwarg for @click.argument() decorator. See docs for more information.

Small changes:

• "Deprecated" text properly handled and stylized in all places.
• Improved rich-click CLI patching.

Backend (mostly invisible) changes:

• Overhauled our test suite to use inline-snapshot! 😁
• Improved test coverage and CI.
• typing_extensions now only required for < Python 3.11.
• RichHelpFormatter now defers printing by default if a user does not specify a Console. [#231] (With contributions from @ofek)
  • This more closely aligns the RichHelpFormatter with how base Click works.
• Significant refactors to help text rendering.
• Reintroduced deprecation warnings for a couple of features deprecated in 1.8.
• There was an issue where the rich.highlighter module could load during CLI execution. We now assert in unit-tests that no rich modules are loaded during code execution, so going forward, rich imports should no longer ever be a side-effect of CLI execution.

Click 8.2 support:

• Fix deprecation warning in Click 8.2. [#239] (@finsberg)
• Fix typing incompatibilities with Click 8.2. [#240, #242] (@finsberg)
• Fixed no_args_is_help=True with Click 8.2: [#241]
• Added Click 8.2's support for Parameter.deprecated: str | bool [#242]

• 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 [#164].

• Add ability to turn off option/command deduplication in groups [#226]
• Fix regression in stderr handling [#164]

• Add ability to turn off option/command deduplication in groups [#226]
• Fix regression in stderr handling [#164]

• Fix incompatibility with click 8.2.0. [#224] (@ppentchev)

• Fix issue with error messages not using user-defined styles. [#215] (@sankarngrjn)

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

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

• Fix another deprecation warning issue.

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

• 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.

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

• Significant improvements to styling for panels.

• 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.

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

• World's most esoteric bug fixed.

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

• Add --rich-config option to the rich-click CLI.
• Better typing for option groups and command groups with TypedDict [#156]
• 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", None] instead of booleans.
• Fixed bug where CLI errors did not output to stderr.

• Set legacy_windows by default to None.

• Fix false deprecation warning.

• Add support for rich formatting in epilog text [#146]

• Fix bug with rich-click CLI not working with Python 3.12. #141
• Fix compatibility issue with dbt-core CLI. [#140]

[!WARNING]

Click 7.x support is deprecated and will be removed in rich-click version 1.8.x. Please update to a newer version of click.

This release comes after merging a huge pull-request from @BrutalSimplicity - see #92

• Extends Click's HelpFormatter class
• Creates a HelpConfiguration class that doubles the current module-level settings
• Added a decorator that allows the HelpConfiguration to be passed into Click via the supported context_settings argument provided by the Command and Group classes.
• The Rich Console object can also be configured per command and is distinct from the Console instance used internally by the formatter. The RichHelpFormatter creates a console based on the RichHelpConfiguration as the tight coupling between the Formatter and Click's internals make it difficult to allow the Console to be configured externally (i.e. one example is that Click expects help formatting to be buffered).
• Created a RichContext class to allow creation of the custom formatter.
• The Rich Command, Group, and Context now expose the Console and RichHelpConfiguration properties.
• Added contributor VSCode settings

This PR closes a number of issues:

• #25: Add tests!
• #90: click.ClickException should output to stderr
• #88: Rich Click breaks contract of Click's format_help and its callers
• #18: Options inherited from context settings aren't applied

In addition, we merged another large pull-request that adds full static type-checking support (see issue #85), and fixes many bugs - see PR #126.

In addition:

• Add new style option STYLE_COMMAND [#102]
• Add new style option WIDTH (in addition to MAX_WIDTH), thanks to @ealap [#110]
• Add new style option STYLE_ERRORS_SUGGESTION_COMMAND [#136]
• Updated styling for Usage: line to avoid off-target effects [#108]
• Click 7.x support has been deprecated. [#117]
• Fixed error where ctx.exit(exit_code) would not show nonzero exit codes.[#114]
• Support click.MultiCommand. [#38]:

Development prerelease of 1.7.0. (Full changelog will be included in full release.)

• Don't show metavars for feature switch options [#100] (@likewei92)

Full Changelog: https://github.com/ewels/rich-click/compare/v1.6.0...v1.6.1

• ⚠️ Removed support for Typer ⚠️
  • Please use the native Typer functionality instead.
• Added self-updating automated readme screengrabs using rich-codex
• Fix AssertionError when using click command call #94

⚠️ Important notice! ⚠️

As of Typer v0.6.0, Typer now supports rich help text natively. Support for Typer in rich-click is now depreciated and will be removed in a future release.

What's changed

• Pin Typer version to <0.6 when installing with pip install rich-click[typer]
• Improve support for arguments [#82]
  • Fixes error with Typer arguments [#59]
  • Adds new style option STYLE_ARGUMENT
• Don't show env vars if None [#84]
• Specify __all__ for type checkers [#83]

New Contributors

• @ajparsons made their first contribution in https://github.com/ewels/rich-click/pull/83
• @AlirezaTheH made their first contribution in https://github.com/ewels/rich-click/pull/82

Full Changelog: https://github.com/ewels/rich-click/compare/v1.5.1...v1.5.2

• 🧹 Updated pip release build CI #78
• 🐛 Added missed occurence of return values when standalone_mode set #79

New Contributors

• @zmoon made their first contribution in https://github.com/ewels/rich-click/pull/78

Full Changelog: https://github.com/ewels/rich-click/compare/v1.5...v1.5.1

• ✨ Add new FORCE_TERMINAL config flag to force colours even when help output is piped. Can also be enabled by setting environment variables GITHUB_ACTIONS, FORCE_COLOR or PY_COLORS
• ✨ Add new OPTION_ENVVAR_FIRST config flag to print environment variables before option help texts instead of after (nice for alignment if all options have an env var).
• 🧹 Refactor config flag MAX_WIDTH to set the console width and not individual panels. Can now also be set with environment variable TERMINAL_WIDTH
• :bug: Fix package syntax in setup.py for py.typed #75
• :bug: Fix printing of return values when standalone_mode set #76

New Contributors

• @Stealthii made their first contribution in https://github.com/ewels/rich-click/pull/75
• @mcflugen made their first contribution in https://github.com/ewels/rich-click/pull/76

Full Changelog: https://github.com/ewels/rich-click/compare/v1.4...v1.5

Another bugfix release where I ended up adding in some more new features. You can now have quite a bit more control over how help texts are styled for options and commands - globally and even at specific group level.

This is particularly useful for those of you with long help texts, as it's now possible to break those up visually with more spacing and custom colours / borders:

What's changed

• ✨ Added support for styling the tables that options and commands are displayed in [#69]
• 🐛 Fixed AttributeError from envvar code in some Typer usage [#70]

Full Changelog: https://github.com/ewels/rich-click/compare/v1.3.2...v1.4

Missed one instance of inspect.cleandoc in the last patch release, this release hopefully covers all the places it's needed (thanks @apcamargo!)

I felt bad doing a release which basically only included 18 characters of new code, so I also snuck in support for showing envvar (click + typer) in help texts:

<img width="1264" alt="image" src="https://user-images.githubusercontent.com/465550/168563469-2a294b3c-fad3-4795-9c48-464f44a9c145.png">

What's changed

• 🐛 Fix missed indentation issue in subcommand help text with inspect.cleandoc [#67]
• ✨ Add support for showing Click / Typer envvar environment variables [#36]

Full Changelog: https://github.com/ewels/rich-click/compare/v1.3.1...v1.3.2

This release is mostly minor bugfixes, many of which are to keep up with changes in the upstream Click codebase.

Many thanks to everyone who has reported problems and contributed pull requests! 👏🏻

Changes

• Bumped minimum version of rich from 10 to 10.7.0 (when Group was introduced)
• Refactored CLI's patching functionality to support from rich_click.cli import patch [#53]
• Make _make_rich_rext remove text indentations using inspect.cleandoc [#55]
• Import rich_click into main namespace for Pylance [#64]
• Add support of new click hidden command parameter [#62]
• Don't show Typer positional arguments unless SHOW_ARGUMENTS is specified [#59]
• Fix \f escape marker for new versions of Click, including in markdown [#60]

New Contributors

• @apcamargo made their first contribution in https://github.com/ewels/rich-click/pull/56
• @lgprobert made their first contribution in https://github.com/ewels/rich-click/pull/62
• @kianmeng made their first contribution in https://github.com/ewels/rich-click/pull/65
• @wfondrie made their first contribution in https://github.com/ewels/rich-click/pull/66

Full Changelog: https://github.com/ewels/rich-click/compare/v1.3.0...v1.3.1

✨ New features

This release contains two main chunks of work:

• Initial support for @tiangolo's Typer, added by @browniebroke [#26]
• A fairly major overhaul of the code to introduce typing and additional code linting (pre-commit with iSort, mypy, Flake8), by @Jorricks [#37, #39, #40]

✍🏻 Output changes:

• Change metavar overflow to fold, so that large numbers of choices flow onto new lines instead of being truncated with an ellipsis [#33]
• Make metavar separators dim ([],<>) (customise with STYLE_METAVAR_SEPARATOR)
• Parse emoji shortcodes :partying_face: [#51]

🐛 Bug fixes:

• Fixed bug where --no-myflag wasn't showing in the help [#45]

👨🏻‍💻 Code changes:

• Distribution now available via MacPorts [#42]
• Pushed minimum version of Python up to 3.7, in line with Click v8.1
• Mark PEP 561 Compatibility [#41]
• Monkey-patch RichCommand and RichGroup in CLI code for better rich-click compatability with more tools [#43]

Full Changelog: https://github.com/ewels/rich-click/compare/v1.2.1...v1.3.0

• Support the command short_help argument [#28]
• Added USE_CLICK_SHORT_HELP global to enable default click shortening of help messages [#28]
• Avoid AttributeError exceptions when using custom exception classes based on click that don't have ctx [#27]
• Fix bug in inverted secondary options [#31]
• Refactor printing options to handle arbitrary numbers of flags [#32]

Full Changelog: https://github.com/ewels/rich-click/compare/v1.2.0...v1.2.1

• New CLI functionality to richifiy via prefix any other tool using click, by @pawamoy [#13]

  $ rich-click awesometool --help
  
  Usage: awesometool [OPTIONS]
  ..more richified output below..
  

• Distribution now available via conda-forge

Full Changelog: https://github.com/ewels/rich-click/compare/v1.1.1...v1.2.0

Hotfix patch release to remove an accidental from turtle import st that crept in due to a pesky VSCode plugin. Many thanks to @ashb for spotting.

• Require at least click v7.0 (released 2018) #16
• Require at least rich v10 (released March 2021) #16
• Handle missing click.types._NumberRangeBase in click 7x #16
• Fix compatibility issue for rich 10.6 (group vs render_group import) #16
• Added support for HEADER_TEXT and FOOTER_TEXT to go before and after help output
• Catch Abort exceptions from cmd+c and print nicely using ABORTED_TEXT
• Unwrap single newlines in option and group-command help texts #23
• Add click \b escape marker functionality into help text rendering #24
• Fix syntax in example in README file by @fridex #15

Full Changelog: https://github.com/ewels/rich-click/compare/v1.0.0...v1.1.0

Major version bump as this release has a new usage method, which no longer requires monkey patching. Many thanks to @willmcgugan for the idea and @grst for discussion and help.

• ⚠️ Major change: New usage, so that we can avoid having to do monkey patching #10.
  • Now use with import rich_click as click
• Add ability to create groups of options with separate panels
• Show positional arguments in their own panel by default
• Add config GROUP_ARGUMENTS_OPTIONS option to group with options
• Improve handing of metavars, give option to show appended instead of in column
• Add COLOR_SYSTEM option to add ability to disable colours
• Add options to customise error message help texts
• Add support for printing errors nicely
• A lot of additional testing and tweaking