annotate docs/index.rst @ 437:9e0fd9da25c6

Added tag 0.6.4 for changeset c4c35f002aef
author catherine.devlin@gmail.com
date Thu, 25 Aug 2011 16:27:53 -0400
parents f7cb69b0da9e
children
rev   line source
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
1 .. cmd2 documentation master file, created by
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
2 sphinx-quickstart on Wed Feb 10 12:05:28 2010.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
3 You can adapt this file completely to your liking, but it should at least
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
4 contain the root `toctree` directive.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
5
358
70fead908abe add info re: assembla page
catherine@Drou
parents: 332
diff changeset
6 cmd2
70fead908abe add info re: assembla page
catherine@Drou
parents: 332
diff changeset
7 ====
70fead908abe add info re: assembla page
catherine@Drou
parents: 332
diff changeset
8
359
5b95dacca46e remove ex2
catherine@Drou
parents: 358
diff changeset
9 A python package for building powerful command-line interpreter (CLI)
5b95dacca46e remove ex2
catherine@Drou
parents: 358
diff changeset
10 programs. Extends the Python Standard Library's cmd_ package.
5b95dacca46e remove ex2
catherine@Drou
parents: 358
diff changeset
11
364
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
12
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
13 .. _`cmd2 project page`: http://www.assembla.com/wiki/show/python-cmd2
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
14 .. _`project bug tracker`: http://trac-hg.assembla.com/python-cmd2/report/1
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
15
359
5b95dacca46e remove ex2
catherine@Drou
parents: 358
diff changeset
16 .. _cmd: http://docs.python.org/library/cmd.html#module-cmd
5b95dacca46e remove ex2
catherine@Drou
parents: 358
diff changeset
17
324
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
18 The basic use of ``cmd2`` is identical to that of cmd_.
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
19
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
20 1. Create a subclass of ``cmd2.Cmd``. Define attributes and
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
21 ``do_*`` methods to control its behavior. Throughout this documentation,
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
22 we will assume that you are naming your subclass ``App``::
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
23
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
24 from cmd2 import Cmd
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
25 class App(Cmd):
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
26 # customized attributes and methods here
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
27
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
28 2. Instantiate ``App`` and start the command loop::
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
29
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
30 app = App()
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
31 app.cmdloop()
332
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 324
diff changeset
32
364
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
33 Resources
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
34 ---------
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
35
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
36 * cmd_
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
37 * `project bug tracker`_
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
38 * `cmd2 project page`_
385
2d244d7a675b setup.py missing from egg?
catherine@dellzilla
parents: 366
diff changeset
39 * `PyCon 2010 presentation <http://us.pycon.org/2010/conference/talks/#proposal_link_153>`_,
2d244d7a675b setup.py missing from egg?
catherine@dellzilla
parents: 366
diff changeset
40 *Easy Command-Line Applications with cmd and cmd2*:
388
52ab96d4f179 fix some Sphinx warnings
anatoly techtonik <techtonik@gmail.com>
parents: 385
diff changeset
41 :doc:`slides <pycon2010/pycon2010>`,
385
2d244d7a675b setup.py missing from egg?
catherine@dellzilla
parents: 366
diff changeset
42 `video <http://python.mirocommunity.com/video/1533/easy-command-line-applications>`_
364
29221236d1a1 updating refresh scripts
cat@eee
parents: 359
diff changeset
43
332
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 324
diff changeset
44 These docs will refer to ``App`` as your ``cmd2.Cmd``
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 324
diff changeset
45 subclass, and ``app`` as an instance of ``App``. Of
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 324
diff changeset
46 course, in your program, you may name them whatever
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 324
diff changeset
47 you want.
324
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
48
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
49 Contents:
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
50
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
51 .. toctree::
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
52 :maxdepth: 2
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
53
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
54 overview
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
55 example
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
56 freefeatures
315
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
57 settingchanges
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
58 unfreefeatures
385
2d244d7a675b setup.py missing from egg?
catherine@dellzilla
parents: 366
diff changeset
59 alternatives
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
60
399
f7cb69b0da9e change version number to 0.6.2
catherine.devlin@gmail.com
parents: 388
diff changeset
61 Compatibility
f7cb69b0da9e change version number to 0.6.2
catherine.devlin@gmail.com
parents: 388
diff changeset
62 =============
f7cb69b0da9e change version number to 0.6.2
catherine.devlin@gmail.com
parents: 388
diff changeset
63
f7cb69b0da9e change version number to 0.6.2
catherine.devlin@gmail.com
parents: 388
diff changeset
64 Tested and working with Python 2.5, 2.6, 2.7, 3.1; Jython 2.5
f7cb69b0da9e change version number to 0.6.2
catherine.devlin@gmail.com
parents: 388
diff changeset
65
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
66 Indices and tables
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
67 ==================
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
68
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
69 * :ref:`genindex`
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
70 * :ref:`modindex`
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
71 * :ref:`search`
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
72