Metadata-Version: 2.1
Name: commandparse
Version: 1.1.2
Summary: CLI application commands parser
Home-page: https://github.com/flgy/commandparse
Author: flgy
Author-email: florian.guilbert@synacktiv.com
License: MIT
Keywords: CLI,command,argparse,parser
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENCE

# commandparse

Module to parse command based CLI application.

Usage:

* Subclass the Command class
* Add a method with a name such as `prefix_commandname` with kwargs as required argument
* Create an ArgumentParser instance
* Call the `Subclass.add_suparsers` with the ArgumentParser instance and other settings
* Use the `dispatch_command` function with the args returned by `parser.parse_args()`

```
parser = ArgumentParser(...)
[...]
Subclass.add_subparsers(parser, prefixes=["get_", "do_", ...], title="commands", description="available commands")

cmd = Subclass(...)
cmd.dispatch_command(commands, args)
```

See example.py for a more complete example. For a real world application using this lib, see: https://github.com/franc-pentest/ldeep
