summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDoug Hellmann <doug.hellmann@dreamhost.com>2012-07-31 11:02:56 -0400
committerDoug Hellmann <doug.hellmann@dreamhost.com>2012-07-31 11:06:53 -0400
commitb12c68fd7bb187c6d74467facc24949e8828f591 (patch)
treea95d55b835c55010d4e14ba48a0d268ee5922b14 /docs
parentce0aa4609c76e60ea580afcfee1f8103931b0fee (diff)
downloadcliff-b12c68fd7bb187c6d74467facc24949e8828f591.tar.gz
Remove tablib formatters from core
The tablib package depends on a "dead" project, so our dependency on it is causing policy issues for having cliff included in Ubuntu. Moving those formatters to a separate project removes the strict dependency. Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/history.rst6
-rw-r--r--docs/source/list_commands.rst55
-rw-r--r--docs/source/show_commands.rst54
3 files changed, 16 insertions, 99 deletions
diff --git a/docs/source/history.rst b/docs/source/history.rst
index e391488..fe180bb 100644
--- a/docs/source/history.rst
+++ b/docs/source/history.rst
@@ -2,6 +2,12 @@
Release History
=================
+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
diff --git a/docs/source/list_commands.rst b/docs/source/list_commands.rst
index f76188b..2be64e7 100644
--- a/docs/source/list_commands.rst
+++ b/docs/source/list_commands.rst
@@ -43,43 +43,6 @@ further manipulation.
"Makefile",5569
"source",408
-html
-----
-
-The ``html`` formatter uses tablib_ to produce HTML output as a table.
-
-::
-
- (.venv)$ cliffdemo files -f html
- <table>
- <thead>
- <tr><th>Name</th>
- <th>Size</th></tr>
- </thead>
- <tr><td>build</td>
- <td>136</td></tr>
- <tr><td>cliffdemo.log</td>
- <td>3252</td></tr>
- <tr><td>Makefile</td>
- <td>5569</td></tr>
- <tr><td>requirements.txt</td>
- <td>33</td></tr>
- <tr><td>source</td>
- <td>782</td></tr>
- </table>
-
-json
-----
-
-The ``json`` formatter uses tablib_ to produce JSON output.
-
-::
-
- (.venv)$ cliffdemo files -f json
- [{"Name": "build", "Size": 136}, {"Name": "cliffdemo.log", "Size":
- 3461}, {"Name": "Makefile", "Size": 5569}, {"Name":
- "requirements.txt", "Size": 33}, {"Name": "source", "Size": 782}]
-
table
-----
@@ -100,21 +63,13 @@ for human consumption.
| source | 408 |
+---------------+------+
-yaml
-----
-
-The ``yaml`` formatter uses tablib_ to produce YAML output as a
-sequence of mappings.
-
-::
+Other Formatters
+----------------
- (.venv)$ cliffdemo files -f yaml
- - {Name: build, Size: 136}
- - {Name: cliffdemo.log, Size: 3043}
- - {Name: Makefile, Size: 5569}
- - {Name: requirements.txt, Size: 33}
- - {Name: source, Size: 816}
+Formatters using tablib_ to produce JSON, YAML, and HTML are available
+as part of `cliff-tablib`_.
+.. _cliff-tablib: https://github.com/dreamhost/cliff-tablib
Creating Your Own Formatter
---------------------------
diff --git a/docs/source/show_commands.rst b/docs/source/show_commands.rst
index e848960..87de6ff 100644
--- a/docs/source/show_commands.rst
+++ b/docs/source/show_commands.rst
@@ -28,43 +28,6 @@ commands. :class:`ShowOne` adds a command line switch to let the user
specify the formatter they want, so you don't have to do any extra
work in your application.
-html
-----
-
-The ``html`` formatter uses tablib_ to produce HTML output as a table.
-
-::
-
- (.venv)$ cliffdemo file -f html setup.py
- <table>
- <thead>
- <tr><th>Field</th>
- <th>Value</th></tr>
- </thead>
- <tr><td>Name</td>
- <td>setup.py</td></tr>
- <tr><td>Size</td>
- <td>6373</td></tr>
- <tr><td>UID</td>
- <td>527</td></tr>
- <tr><td>GID</td>
- <td>501</td></tr>
- <tr><td>Modified Time</td>
- <td>1336353173.0</td></tr>
- </table>
-
-json
-----
-
-The ``json`` formatter uses tablib_ to produce JSON output.
-
-::
-
- (.venv)$ cliffdemo file -f json setup.py
- [{"Field": "Name", "Value": "setup.py"}, {"Field": "Size",
- "Value": 6373}, {"Field": "UID", "Value": 527}, {"Field": "GID",
- "Value": 501}, {"Field": "Modified Time", "Value": 1336353173.0}]
-
shell
-----
@@ -106,20 +69,13 @@ formatted for human consumption.
| Modified Time | 1335569964.0 |
+---------------+--------------+
-yaml
-----
+Other Formatters
+----------------
-The ``yaml`` formatter uses tablib_ to produce YAML output as a
-sequence of mappings.
-
-::
+Formatters using tablib_ to produce JSON, YAML, and HTML are available
+as part of `cliff-tablib`_.
- (.venv)$ cliffdemo file -f yaml setup.py
- - {Field: Name, Value: setup.py}
- - {Field: Size, Value: 6373}
- - {Field: UID, Value: 527}
- - {Field: GID, Value: 501}
- - {Field: Modified Time, Value: 1336353173.0}
+.. _cliff-tablib: https://github.com/dreamhost/cliff-tablib
Creating Your Own Formatter
---------------------------