corgy
Elegant command line parsing for Python.
Corgy allows you to create a command line interface in Python, without worrying about boilerplate code. This results in cleaner, more modular code.
from corgy import Corgy
class ArgGroup(Corgy):
arg1: Annotated[Optional[int], "optional number"]
arg2: Annotated[bool, "a boolean"]
class MyArgs(Corgy):
arg1: Annotated[int, "a number"] = 1
arg2: Annotated[Sequence[float], "at least one float"]
grp1: Annotated[ArgGroup, "group 1"]
args = MyArgs.parse_from_cmdline()
Compare this to the equivalent code which uses argparse:
from argparse import ArgumentParser, BooleanOptionalAction
parser = ArgumentParser()
parser.add_argument("--arg1", type=int, help="a number", default=1)
parser.add_argument("--arg2", type=float, nargs="+", help="at least one float", required=True)
grp_parser = parser.add_argument_group("group 1")
grp_parser.add_argument("--grp1:arg1", type=int, help="optional number")
grp_parser.add_argument("--grp1:arg2", help="a boolean", action=BooleanOptionalAction)
args = parser.parse_args()
Corgy also provides support for more informative help messages from argparse, and colorized output:
Install
corgy is available on PyPI, and can be installed with pip:
pip install corgy
The full corgy package requires Python 3.9 or higher. Python 3.7 and 3.8 are also supported, but only have access to CorgyHelpFormatter, and corgy.types.
Support for colorized output requires the crayons package, also available on PyPI. You can pull it as a dependency for corgy by installing with the colors extra:
pip install corgy[colors]
Usage
For documentation on usage, refer to docs/index.md.
7 Dec 1, 2021
634 Dec 22, 2022
17k Jan 2, 2023
3.2k Jan 9, 2023
22 Jan 3, 2023
0 Jun 19, 2022
10.1k Jan 2, 2023
64 Dec 27, 2022
3k Jan 1, 2023
305 Dec 25, 2022
23.6k Dec 31, 2022
1 Aug 14, 2022
82 Dec 28, 2022
7.7k Dec 30, 2022
7 Aug 09, 2022
13.3k Dec 31, 2022
1.1k Jan 08, 2023
990 Jan 01, 2023
2 Dec 22, 2022
1.1k Dec 31, 2022
8.1k Jan 04, 2023
63 Nov 12, 2022
1.4k Jan 07, 2023