Releases: ewels/rich-click
v1.1.1 - Patch release to remove accidental import
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.
v1.1.0 - Pinned version requirements, newlines and aborts
- 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
vsrender_group
import) #16 - Added support for
HEADER_TEXT
andFOOTER_TEXT
to go before and after help output - Catch Abort exceptions from
cmd+c
and print nicely usingABORTED_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: v1.0.0...v1.1.0
v1.0.0 - First major release with new usage and features
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
- Now use with
- 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
v0.3.0 - Command group panels, markdown/up
- Add ability to create groups of commands with separate panels
- Add support for rich console markup or Markdown in help texts
- Set default for
MAX_WIDTH
toNone
instead of100
- Switch boolean option
SKIP_ARGUMENTS
toSHOW_ARGUMENTS
- Improve regular expression for flags like
-bg
- Use click's string for default value, instead of the value directly
- Show some previously missed metavar types (eg. choice and range options)
- Stripped required-asterisk column from options table if none are required
v0.2.0 - Customise all the things
- Made most styling decisions configurable
- Added support for more click parameters
- Showing default values, showing if required, showing if deprecated, epilog
- Option now hidden if set in click
v0.1.2 - Python 3.6 support
Tested on Python 3.6 and it seems fine, so I've dropped the requirement down to this instead of Python 3.7.
v0.1.1 - The first working release
There's probably a reason why you shouldn't throw together a new package and publish it on PyPI at midnight, just before bed, when you're sleep deprived with small children.
This release fixes a bug in the setup.cfg
that broke the installation.
v0.1.0 - The first release
Initial development version of rich-click
, mostly as a proof of concept.
Supports basic generic functionality for printing help from click commands and groups.
Code was initially written by @willmcgugan for rich-cli
and then further developed by @ewels.