From caeb467f5b365033b1cd4b1b72dff969cd7aeefe Mon Sep 17 00:00:00 2001 From: Stephen DiCato Date: Fri, 9 May 2014 16:35:27 -0400 Subject: [PATCH 1/3] Strip trailing whitespace. --- docs/scenarios/cli.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst index 2153580..9f2928a 100644 --- a/docs/scenarios/cli.rst +++ b/docs/scenarios/cli.rst @@ -6,7 +6,7 @@ Command Line Applications Clint ----- -`clint `_ is a python module which is +`clint `_ is a python module which is filled with very useful tools for developing commandline applications. It supports features such as; CLI Colors and Indents, Simple and Powerful Column Printer, Iterator based progress bar and Implicit argument handling. @@ -15,8 +15,8 @@ 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 +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 @@ -29,9 +29,9 @@ 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. From 20e5aaba6923c2406ac4f8a16d125408b7d5089a Mon Sep 17 00:00:00 2001 From: Stephen DiCato Date: Fri, 9 May 2014 16:36:24 -0400 Subject: [PATCH 2/3] Fix a few minor typos. Standardize on "command line", not "command-line". --- docs/scenarios/cli.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst index 9f2928a..6a11a85 100644 --- a/docs/scenarios/cli.rst +++ b/docs/scenarios/cli.rst @@ -7,7 +7,7 @@ Clint ----- `clint `_ is a python module which is -filled with very useful tools for developing commandline applications. +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. @@ -34,7 +34,7 @@ plac is a simple wrapper over the python standard library `argparse Date: Mon, 12 May 2014 10:40:25 -0400 Subject: [PATCH 3/3] Rename "command line" to "command-line". --- docs/scenarios/cli.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/scenarios/cli.rst b/docs/scenarios/cli.rst index 6a11a85..7c87eb2 100644 --- a/docs/scenarios/cli.rst +++ b/docs/scenarios/cli.rst @@ -1,46 +1,46 @@ -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 command line applications. +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 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 +scripts for themselves, choosing the command-line interface because it is quick 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 some basic argument parsing and then invokes a sub-command to do the work.