summaryrefslogtreecommitdiff
path: root/announce.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug.hellmann@dreamhost.com>2012-07-31 14:01:39 -0400
committerDoug Hellmann <doug.hellmann@dreamhost.com>2012-07-31 15:12:19 -0400
commit8896e385ebc963145677303bf8d6eb134dcf582c (patch)
tree1dce3d965f14f8b9dc27e5ba9b56e2b084014638 /announce.rst
parentce0aa4609c76e60ea580afcfee1f8103931b0fee (diff)
downloadcliff-tablib-8896e385ebc963145677303bf8d6eb134dcf582c.tar.gz
Start cliff-tablib repo
This repo is a fork of the original cliff repo, with the cliff parts removed and the rest changed to just package the tablib-based formatters. Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Diffstat (limited to 'announce.rst')
-rw-r--r--announce.rst29
1 files changed, 13 insertions, 16 deletions
diff --git a/announce.rst b/announce.rst
index 91bcfac..170703f 100644
--- a/announce.rst
+++ b/announce.rst
@@ -1,6 +1,6 @@
-======================================================================
- cliff -- Command Line Interface Formulation Framework -- version 1.0
-======================================================================
+=================================================
+ cliff-tablib -- Formatting Extensions for Cliff
+=================================================
.. tags:: python cliff release DreamHost
@@ -8,25 +8,22 @@ cliff is a framework for building command line programs. It uses
setuptools entry points to provide subcommands, output formatters, and
other extensions.
+cliff-tablib is a set of formatter extensions for producing JSON,
+YAML, and HTML output. Installing cliff-tablib activates these
+formatters for any cliff-based programs automatically.
+
What's New In This Release?
===========================
-- 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 ``Command`` to add ``take_action()``
- and make ``run()`` a concrete method. Existing users should only
- need to rename ``run()`` to ``take_action()`` since the function
- signatures have not changed.
-- In ``Lister`` and ``ShowOne`` use ``take_action()`` instead of
- ``get_data()``.
+- This is the first release in which the tablib extensions
+ are being released as a separate project from cliff.
Documentation
=============
-`Documentation for cliff`_ is hosted on `readthedocs.org`_
+`Documentation for cliff-tablib`_ is hosted on `readthedocs.org`_
-.. _Documentation for cliff: http://readthedocs.org/docs/cliff/en/latest/
+.. _Documentation for cliff-tablib: http://readthedocs.org/docs/cliff-tablib/en/latest/
.. _readthedocs.org: http://readthedocs.org
@@ -35,9 +32,9 @@ Installation
Use pip::
- $ pip install cliff
+ $ pip install cliff-tablib
See `the installation guide`_ for more details.
-.. _the installation guide: http://cliff.readthedocs.org/en/latest/install.html
+.. _the installation guide: http://cliff-tablib.readthedocs.org/en/latest/install.html