summaryrefslogtreecommitdiff
path: root/doxygen/xml/namespacesetup.xml
blob: 1454d09b6e8d786acf3c242d6f6c7dbc6f38d9ef (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.5.1">
  <compounddef id="namespacesetup" kind="namespace">
    <compoundname>setup</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacesetup_1a7b92894168460f935bc49467954c4a92" prot="public" static="no" mutable="no">
        <type>string</type>
        <definition>string setup::author</definition>
        <argsstring></argsstring>
        <name>author</name>
        <initializer>&apos;Catherine Devlin&apos;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="18" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="18" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a4ead8e1ca45242906fde7d5489f3beaa" prot="public" static="no" mutable="no">
        <type>string</type>
        <definition>string setup::author_email</definition>
        <argsstring></argsstring>
        <name>author_email</name>
        <initializer>&apos;catherine.devlin@gmail.com&apos;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="19" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="19" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1aa6d1b3ef82314b74854a1a1a473aadbf" prot="public" static="no" mutable="no">
        <type>list</type>
        <definition>list setup::classifiers</definition>
        <argsstring></argsstring>
        <name>classifiers</name>
        <initializer>[
        &apos;Development Status :: 4 - Beta&apos;,
        &apos;Environment :: Console&apos;,
        &apos;Operating System :: OS Independent&apos;,
        &apos;Intended Audience :: Developers&apos;,
        &apos;Intended Audience :: System Administrators&apos;,
        &apos;Programming Language :: Python&apos;,
        &apos;License :: OSI Approved :: MIT License&apos;,
        &apos;Topic :: Software Development :: Libraries :: Python Modules&apos;,
    ]</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="51" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="51" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a4ad612547892c74be7035043265eb65c" prot="public" static="no" mutable="no">
        <type>string</type>
        <definition>string setup::description</definition>
        <argsstring></argsstring>
        <name>description</name>
        <initializer>&quot;Extra features for standard library&apos;s cmd module&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="20" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="20" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a63491535b376b15204c70db3fe9924d2" prot="public" static="no" mutable="no">
        <type>list</type>
        <definition>setup::install_requires</definition>
        <argsstring></argsstring>
        <name>install_requires</name>
        <initializer>[&apos;pyparsing&gt;=1.5.6&apos;]</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="10" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="10" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a97e6300ec1966f2580ee08f1f55e2f46" prot="public" static="no" mutable="no">
        <type>string</type>
        <definition>string setup::keywords</definition>
        <argsstring></argsstring>
        <name>keywords</name>
        <initializer>&apos;command prompt console cmd&apos;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="22" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="22" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a22ada03d1aaa82c1c9c27d0ae25da2b7" prot="public" static="no" mutable="no">
        <type>string</type>
        <definition>string setup::license</definition>
        <argsstring></argsstring>
        <name>license</name>
        <initializer>&apos;MIT&apos;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="21" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="21" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a718ebc1d14d8aaf7bf72092d219f19fa" prot="public" static="no" mutable="no">
        <type>string</type>
        <definition>string setup::long_description</definition>
        <argsstring></argsstring>
        <name>long_description</name>
        <initializer>&quot;&quot;&quot;Enhancements for standard library&apos;s cmd module.

Drop-in replacement adds several features for command-prompt tools:

    * Searchable command history (commands: &quot;hi&quot;, &quot;li&quot;, &quot;run&quot;)
    * Load commands from file, save to file, edit commands in file
    * Multi-line commands
    * Case-insensitive commands
    * Special-character shortcut commands (beyond cmd&apos;s &quot;@&quot; and &quot;!&quot;)
    * Settable environment parameters
    * Parsing commands with flags
    * &gt; (filename), &gt;&gt; (filename) redirect output to file
    * &lt; (filename) gets input from file
    * bare &gt;, &gt;&gt;, &lt; redirect to/from paste buffer
    * accepts abbreviated commands when unambiguous
    * `py` enters interactive Python console
    * test apps against sample session transcript (see example/example.py)

Useable without modification anywhere cmd is used; simply import <ref refid="classcmd2_1_1Cmd" kindref="compound">cmd2.Cmd</ref> in place of cmd.Cmd.

Running `2to3 &lt;http://docs.python.org/library/2to3.html&gt;` against ``cmd2.py`` 
generates working, Python3-based code.

See docs at http://packages.python.org/cmd2/
&quot;&quot;&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="25" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="25" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a4b28e5b21e957c451ff3aa28f58c6383" prot="public" static="no" mutable="no">
        <type>string</type>
        <definition>string setup::name</definition>
        <argsstring></argsstring>
        <name>name</name>
        <initializer>&quot;cmd2&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="12" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="12" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1ac5fe8cd1e8f4b711518bb89b57cd2baa" prot="public" static="no" mutable="no">
        <type>list</type>
        <definition>list setup::py_modules</definition>
        <argsstring></argsstring>
        <name>py_modules</name>
        <initializer>[&quot;cmd2&quot;]</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="14" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="14" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a7c3763764f99123690822c047e74c36e" prot="public" static="no" mutable="no">
        <type>string</type>
        <definition>string setup::url</definition>
        <argsstring></argsstring>
        <name>url</name>
        <initializer>&apos;http://packages.python.org/cmd2/&apos;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="23" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="23" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a82e52b3a26189d7e3bdbf2bc02b5d721" prot="public" static="no" mutable="no">
        <type></type>
        <definition>setup::use_2to3</definition>
        <argsstring></argsstring>
        <name>use_2to3</name>
        <initializer>True,</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="15" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="15" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="namespacesetup_1a8b86ddd5b5591d99de08e584197a53d9" prot="public" static="no" mutable="no">
        <type>string</type>
        <definition>string setup::version</definition>
        <argsstring></argsstring>
        <name>version</name>
        <initializer>&quot;0.6.4&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="13" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="13" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacesetup_1abf9d3e0287e770123ae15c37ce1173e5" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def setup::find_packages</definition>
        <argsstring></argsstring>
        <name>find_packages</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="6" bodyfile="/Users/amrogers/Developer/Projects/cmd2/setup.py" bodystart="6" bodyend="7"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/Users/amrogers/Developer/Projects/cmd2/setup.py" line="1"/>
  </compounddef>
</doxygen>