Skip to content

Minor improvements to 'Command Line Applications' docs #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sigmavirus24 merged 3 commits into from
May 12, 2014
Merged

Minor improvements to 'Command Line Applications' docs #426

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
caeb467
Strip trailing whitespace.
dicato May 9, 2014
20e5aab
Fix a few minor typos.
dicato May 9, 2014
540e444
Rename "command line" to "command-line".
dicato May 12, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/scenarios/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
Command Line Applications
Command-line Applications
=========================

.. todo:: Explain "Command Line Applications"
.. todo:: Explain "Command-line Applications"

Clint
-----

`clint <https://pypi.python.org/pypi/clint/>`_ is a python module which is
filled with very useful tools for developing commandline applications.
`clint <https://pypi.python.org/pypi/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 <http://click.pocoo.org/>`_ 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 <http://click.pocoo.org/>`_ 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 <http://docopt.org/>`_ 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 <https://pypi.python.org/pypi/plac>`_ is a python module that allows developing command line applications. In fact
plac is a simple wrapper over the python standard library `argparse <http://docs.python.org/2/library/argparse.html>`_, it hides most of its
complexity by using a declarative interface: the argument parser is inferred
`Plac <https://pypi.python.org/pypi/plac>`_ is a python module that allows developing command-line applications. In fact
plac is a simple wrapper over the python standard library `argparse <http://docs.python.org/2/library/argparse.html>`_, 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
Expand All @@ -40,7 +40,7 @@ and simple.
Cliff
------

`Cliff <https://cliff.readthedocs.org/en/latest>`_ is a framework for building command line programs.
`Cliff <https://cliff.readthedocs.org/en/latest>`_ 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.