1.7.0dev

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

v1.6.1

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

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

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

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

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

⚠️ 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 #83
• @alirezatheh made their first contribution in #82

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

v1.5.1 - Patch for `standalone_mode`

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

v1.5 - Stacked env vars and better automation

• ✨ 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
• 🐛 Fix package syntax in setup.py for py.typed #75
• 🐛 Fix printing of return values when standalone_mode set #76

New Contributors

• @Stealthii made their first contribution in #75
• @mcflugen made their first contribution in #76

Full Changelog: v1.4...v1.5

v1.4 - Styled output tables 🌈

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: v1.3.2...v1.4

v1.3.2 - Bonus bugfix, add support for envvar

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:

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: v1.3.1...v1.3.2

v1.3.1 - Bugfixes, keeping up with Click releases

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 #56
• @lgprobert made their first contribution in #62
• @kianmeng made their first contribution in #65
• @wfondrie made their first contribution in #66

Full Changelog: v1.3.0...v1.3.1

v1.3.0 - Typer support & refactoring

✨ 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: v1.2.1...v1.3.0