diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst index 2153580..7c87eb2 100644 --- a/docs/scenarios/cli.rst +++ b/docs/scenarios/cli.rst @@ -1,37 +1,37 @@ -Command Line Applications +Command-line Applications ========================= -.. todo:: Explain "Command Line Applications" +.. todo:: Explain "Command-line Applications" Clint ----- -`clint `_ is a python module which is -filled with very useful tools for developing commandline applications. +`clint `_ is a python module which is +filled with very useful tools for developing command-line applications. It supports features such as; CLI Colors and Indents, Simple and Powerful Column Printer, Iterator based progress bar and Implicit argument handling. Click ----- -`click `_ is an upcoming Python package for creating command -line interfaces in a composable way with as little amount of code as -necessary. It’s the “Command Line Interface Creation Kit”. It’s highly +`click `_ is an upcoming Python package for creating +command-line interfaces in a composable way with as little amount of code as +necessary. It’s the “Command-line Interface Creation Kit”. It’s highly configurable but comes with good defaults out of the box. docopt ------ `docopt `_ is a lightweight, highly Pythonic package that -allows creating command line interfaces easily and intuitively, by parsing +allows creating command-line interfaces easily and intuitively, by parsing POSIX-style usage instructions. Plac ------ -`Plac `_ is a python module that allows developing command line applications. In fact -plac is a simple wrapper over the python standard library `argparse `_, it hides most of its -complexity by using a declarative interface: the argument parser is inferred +`Plac `_ is a python module that allows developing command-line applications. In fact +plac is a simple wrapper over the python standard library `argparse `_, it hides most of its +complexity by using a declarative interface: the argument parser is inferred rather than written down by imperatively. It is targetting especially unsophisticated users, programmers, sys-admins, scientists and in general people writing throw-away scripts for themselves, choosing the command-line interface because it is quick @@ -40,7 +40,7 @@ and simple. Cliff ------ -`Cliff `_ is a framework for building command line programs. +`Cliff `_ is a framework for building command-line programs. It uses setuptools entry points to provide subcommands, output formatters, and other extensions. The framework -is meant to be used to create multi-level commands such as subversion and git, where the main program handles +is meant to be used to create multi-level commands such as subversion and git, where the main program handles some basic argument parsing and then invokes a sub-command to do the work.