summaryrefslogtreecommitdiff
path: root/README.rst
blob: f1c5e41f47d9005e9db2e5c3cee8aa803710273f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
=======================================================
 cliff -- Command Line Interface Formulation Framework
=======================================================

cliff is a framework for building command line programs. It uses
setuptools entry points to provide subcommands, output formatters, and
other extensions.

Documentation
=============

Documentation for cliff is hosted on readthedocs.org at http://readthedocs.org/docs/cliff/en/latest/

To do
=====

- Should commands have an explicit API for checking whether the user
  can invoke them?
- example show app
- change API for list app to expect a sequence of dictionaries?
- unicode output for python 2 (incompatible with csv?)
- json formatter(s)
- pprint formatter(s)
- pretty but non-table formatter(s)
- shell script formatter(s)? (properties as variable names)
- create a few example commands that use a sqlite database to show how
  to manage transactions
- switch setup/teardown functions in app to use some sort of context
  manager?
- switch to distutils2 and the extensions package?
  - http://docs.python.org/dev/packaging/setupcfg.html
  - http://pypi.python.org/pypi/extensions