Does a rich_argparse example fit in the documentation anywhere?

[peterjc]

I was pleased to find I could combine yapx with rich_argparse (from https://github.com/hamdanal/rich-argparse ) as follows:

from rich_argparse import RichHelpFormatter
import yapx

def say_hello(name: str = 'World'):
    print(f"Hello {name}")

yapx.run(say_hello, formatter_class=RichHelpFormatter)

Sample output with the colours done via rich (cropped):

Can you see where this might fit in the yapx documentation?

[peterjc]

A more complete example showing how to set the help text and metavar (and presumably any other property familiar to argparse users):

from typing import Annotated
from rich_argparse import RichHelpFormatter
import yapx


def say_hello(
    name: Annotated[
        str, yapx.arg(help="Who or what to greet?", metavar="NAME")
    ] = "World",
):
    print(f"Hello {name}")


yapx.run(say_hello, formatter_class=RichHelpFormatter)

And the output (right cropped):

[peterjc]

I've only just realized that this works "out of the box", if rich-argparse is installed, then it gets used automatically. Nice!

yapx/src/yapx/utils.py

Line 102 in e814d71

from rich_argparse import RawTextRichHelpFormatter as RawTextHelpFormatter

I guess that means there is no need for an example using RichHelpFormatter explicitly.

[fresh2dev]

You got it 👍 I'll make this capability more clear in the docs before I cut the next release.