cliff/demoapp
Masayuki Igawa f7c9713c53 Fix cliff URLs in doc and demoapp
This commit fixes cliff URLs in the documents and demoapp.

Change-Id: I5a190841d1126119eddacedd02667efd52709330
2016-07-28 16:08:47 +09:00
..
cliffdemo Set demo app up with deferred help 2015-07-24 15:44:06 +00:00
README.rst Fix typo. 2013-01-03 21:38:50 -06:00
setup.py Fix cliff URLs in doc and demoapp 2016-07-28 16:08:47 +09:00

Running demoapp

Setup

First, you need to create a virtual environment and activate it.

$ pip install virtualenv
$ virtualenv .venv
$ . .venv/bin/activate
(.venv)$ 

Next, install cliff in the environment.

(.venv)$ python setup.py install

Now, install the demo application into the virtual environment.

(.venv)$ cd demoapp
(.venv)$ python setup.py install

Usage

With cliff and the demo setup up, you can now play with it.

To see a list of commands available, run:

(.venv)$ cliffdemo --help

One of the available commands is "simple" and running it

(.venv)$ cliffdemo simple

produces the following

sending greeting
hi!

To see help for an individual command, include the command name on the command line:

(.venv)$ cliffdemo files --help

Cleaning Up

Finally, when done, deactivate your virtual environment:

(.venv)$ deactivate
$