summaryrefslogtreecommitdiff
path: root/docs/source/history.rst
blob: d1dfcf0ec859c51c51b1c2797970dfb6e5787da9 (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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
=================
 Release History
=================

dev

- Change the formatters attribute of display commands to reflect the
  fact that it is meant to be an implementation detail of the base
  class, and not used or modified by outsiders.

1.5.2

- Fix the arguments passed to commands when they are instantiated to
  pull out help. See https://github.com/dreamhost/cliff/issues/52 for
  details.
- Add bash command completion. (Contributed by Terry Howe)
- Use stevedore to load formatter plugins.
- Use pbr for packaging.

1.4.5

- Update the pyparsing dependency to a version that supports both
  Python 2 and Python 3.
- Add PyPy testing.

1.4.4

- Provide better error handling for unknown commands run from the
  command line. (Contributed by Christophe Chauvet.)

1.4.3

- More stdout encoding issues with Python 2.6.

1.4.2

- Fix an issue with unicode output under Python 2.6. See
  https://github.com/dreamhost/cliff/pull/40 for details.

1.4.1

- Add ``dict2columns`` method to ``ShowOne``. (Contributed by Dean
  Troyer)
- Pin the requirement for cmd2 more tightly.

1.4

- Store a reference to the InteractiveApp on the App while in
  interactive mode to allow commands to update the interactive
  state. (Contributed by Tomaz Muraus)
- Remove reliance on distribute, now that it has merged with
  setuptools 0.7. Providing an explicit dependency on setuptools
  breaks updates in some cases, so just fail if it isn't there.

1.3.3

  - Restore compatibility with prettytable < 0.7.2 by forcing no
    output if there is no data (instead of printing an empty
    table). Contributed by Dirk Mueller.
  - Update to allow cmd2 version 0.6.5.1. Contributed by Dirk Mueller.

1.3.2

  - Add ``convert_underscores`` parameter to ``CommandManager`` ``__init__``
    method to allow underscores to be used in command names. This optional
    argument is defaulted to True to maintain current behavior.
    (contributed by Joe Server)
  - Use flake8_ for style checking.
  - Relax version requirement for PrettyTable dependency to allow
    point releases of 0.7.

.. _flake8: https://pypi.python.org/pypi/flake8

1.3.1

  - Sort list of commands in interactive help mode. (contributed by
    Ilya Shakhat)
  - Fix a dependency issue with PyParsing until the cmd2 package can
    release an update setting the version of its dependency based on
    the Python version.

1.3

  - Allow user to pass ``argparse_kwargs`` argument to the
    ``build_option_parser`` method. This argument can contain extra
    keyword arguments which are passed to the ``ArgumentParser`` constructor.
    (contributed by Tomaz Muraus)
  - Updated documentation to include dependency on distribute.

1.2.1

  - Fix problem with documentation packaging.
  - Fix problem with missing ``izip`` import in ``lister.py``.

1.2

  - Fix problem with interactive mode ``help`` command.
  - Disable logging by default but add a ``--log-file`` option to
    re-enable it at runtime.
  - Add support for python 2.6. (contributed by Mark McClain for
    OpenStack Quantum)

1.1.2

  - Fix a packaging problem introduced in version 1.1.

1.1

  - Move tablib support (JSON, YAML, and HTML formatters) to a
    separate project to comply with Ubuntu packaging requirements. See
    https://github.com/dreamhost/cliff-tablib

1.0

  - Add trailing newlines after output from tablib-based formatters
    (JSON, YAML, and HTML). Contributed by Matt Joyce.
  - Some :pep:`8` fixes.
  - Refactor the API in :class:`Command` to add :func:`take_action`
    and make :func:`run` a concrete method. Existing users should only
    need to rename :func:`run()` to :func:`take_action()` since the
    function signatures have not changed.
  - In :class:`Lister` and :class:`ShowOne` use :func:`take_action`
    instead of :func:`get_data`.

0.7

  - Clean up interactive mode flag setting.
  - Add support for Python 2.6, contributed by heavenshell.
  - Fix multi-word commands in interactive mode.

0.6

  - Pass the non-global argument list to :func:`initialize_app` to be
    used in initialization work.

0.5.1

  - Remove pinned version requirement for PrettyTable until the
    OpenStack clients catch up to the API change.

0.5

  - Asking for help about a command by prefix lists all matching
    commands.
  - Add formatters for HTML, JSON, and YAML.

0.4

  - Add shell formatter for single objects.
  - Add interactive mode.
  - Expand documentation.

0.3

  - Add ShowOne base class for commands that show details about single
    objects.
  - Fix a problem with Lister when there is no data to be printed.

0.2

  - Incorporate changes from dtroyer to replace use of optparse in App
    with argparse.
  - Added "help" subcommand to replace ``--help`` option handling in
    subcommands.

0.1

  - Initial public release.
  - Included App, CommandManager, Lister, csv and table formatters, a
    demo application, and basic documentation.