Skip to content

Releases: ewels/rich-click

v1.7.3

05 Jan 15:54
7d40b91
Compare
Choose a tag to compare
  • Fix false deprecation warning.

v1.7.2

02 Dec 23:14
Compare
Choose a tag to compare
  • Add support for rich formatting in epilog text [#146]

v1.7.1

01 Nov 00:39
Compare
Choose a tag to compare
  • Fix bug with rich-click CLI not working with Python 3.12. #141
  • Fix compatibility issue with dbt-core CLI. [#140]

v1.7.0

11 Oct 11:30
Compare
Choose a tag to compare

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]:

v1.7.0dev1

07 Oct 19:16
Compare
Choose a tag to compare
v1.7.0dev1 Pre-release
Pre-release

More bugfixes to 1.7.0.

1.7.0dev

07 Oct 00:30
Compare
Choose a tag to compare
1.7.0dev Pre-release
Pre-release

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

v1.6.1

19 Jan 06:05
dd63c46
Compare
Choose a tag to compare

Full Changelog: v1.6.0...v1.6.1

v1.6.0 - Drop Typer support, bugfixes + screenshots.

05 Dec 08:43
Compare
Choose a tag to compare
  • ⚠️ Removed support for Typer ⚠️
  • Added self-updating automated readme screengrabs using rich-codex
  • Fix AssertionError when using click command call #94

v1.5.2 - Better arguments, minor tweaks & bug fixes

01 Aug 22:12
Compare
Choose a tag to compare

⚠️ 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

Full Changelog: v1.5.1...v1.5.2

v1.5.1 - Patch for `standalone_mode`

22 Jun 17:55
Compare
Choose a tag to compare
  • 🧹 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 #78

Full Changelog: v1.5...v1.5.1