This is the last release to support Python 3.8
Introducing auto-rich-argparse
π
Improve the help output of your favorite argparse command line tool by simply installing auto-rich-argparse
in its environment. Try it out with your favorite tool using:
uvx --with auto-rich-argparse <YOUR_FAVORITE_TOOL> --help
Read more at https://github.com/hamdanal/auto-rich-argparse.
Incoming Change in Version 2.0
In rich-argparse 2.0, rich markup will become opt in instead of opt out. This means usages like this:
parser.add_argument("--foo", help="[red]This text is in red[/]")
Will need to set the option RichHelpFormatter.help_markup = True
to work as expected. Please see #151 for context and to give feedback.
What's Changed
This release adds new features and fixes a few bugs.
Features
- Add support for django commands in the new
rich_argparse.django
module. Read more at https://github.com/hamdanal/rich-argparse#django-support. Contributed in #149 - Add
ParagraphRichHelpFormatter
, a formatter that preserves paragraph breaks, in the newrich_argparse.contrib
module. Read more at https://github.com/hamdanal/rich-argparse#additional-formatters. Contributed in #147
Fixes
- Fix
ValueError
when using%(default)s
inside square brackets andhelp_markup
is enabled. Contributed in #153 and #154 - Do not highlight --options inside backticks. Contributed in #142
Other Changes
- Start testing on Python 3.14 by @hamdanal in #137
- Use native toml for tox configuration by @hamdanal in #138
- sdist: include the tests by @mr-c in #139
- Reorganize the project modules by @hamdanal in #144
- Run skipped test on Python 3.13 by @hamdanal in #145
- Replace tox by uv by @hamdanal in #146
- Bump astral-sh/setup-uv from 4 to 5 by @dependabot in #148
- Add python nightly workflow by @hamdanal in #150
New Contributors
Full Changelog: v1.6.0...v1.7.0