Versions

Description

For authors of command-line utilities. Simplifies: 1) Defining command-line options and parameters, 2) Parsing the command line, and 3) Displaying usage instructions to the console.

Utility developers will 1) Subclass a module-defined class, 2) Include a YAML spec in the subclass to define the utility’s options and usage, and 3) Invoke the module arg parser. When the utility is run, if the command line is valid according to the YAML schema, then the supplied args are injected into the subclass by the parser. Otherwise errors are automatically displayed to the console.

If the user specifies ‘-h’ or ‘–help’ on the command line, then usage instructions are displayed as defined in the YAML, in a form generally recognizable to users of console utilities. Specifically, displays summary usage, detailed options and params (including categorized options), positional params, and examples.

Repository

https://github.com/aceeric/pycmdparse.git

Project Slug

pycmdparse

Last Built

2 months, 1 week ago passed

Maintainers

Home Page

https://github.com/aceeric/pycmdparse

Badge

Tags

command, commandline, line

Project Privacy Level

Public

Short URLs

pycmdparse.readthedocs.io
pycmdparse.rtfd.io

Default Version

latest

'latest' Version

master