summaryrefslogtreecommitdiff
path: root/README.rst
blob: d72731c093d59c425b8577b7f027503cef845c4b (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?
- 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)
- 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?
- add options to csv formatter to control output (delimiter, etc.)
- option to spit out bash completion data
- move command execution into a separate class to be used by App and
  InteractiveApp?
- refactor Lister and ShowOne to share common base (at least for
  loading plugins)