summaryrefslogtreecommitdiff
path: root/demoapp/README.rst
blob: 24ca9b6ad1eb435150e0d058c06b6c95bafceb69 (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
=================
 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
  $