File: PKG-INFO

package info (click to toggle)
python-argh 0.26.2-1.1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 296 kB
  • sloc: python: 1,586; makefile: 4
file content (298 lines) | stat: -rw-r--r-- 10,728 bytes parent folder | download | duplicates (4)
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
Metadata-Version: 1.1
Name: argh
Version: 0.26.2
Summary: An unobtrusive argparse wrapper with natural syntax
Home-page: http://github.com/neithere/argh/
Author: Andrey Mikhaylenko
Author-email: neithere@gmail.com
License: GNU Lesser General Public License (LGPL), Version 3
Description: Argh: The Natural CLI
        =====================
        
        .. image:: https://img.shields.io/coveralls/neithere/argh.svg
            :target: https://coveralls.io/r/neithere/argh
        
        .. image:: https://img.shields.io/travis/neithere/argh.svg
            :target: https://travis-ci.org/neithere/argh
        
        .. image:: https://img.shields.io/pypi/format/argh.svg
            :target: https://pypi.python.org/pypi/argh
        
        .. image:: https://img.shields.io/pypi/status/argh.svg
            :target: https://pypi.python.org/pypi/argh
        
        .. image:: https://img.shields.io/pypi/v/argh.svg
            :target: https://pypi.python.org/pypi/argh
        
        .. image:: https://img.shields.io/pypi/pyversions/argh.svg
            :target: https://pypi.python.org/pypi/argh
        
        .. image:: https://img.shields.io/pypi/dd/argh.svg
            :target: https://pypi.python.org/pypi/argh
        
        .. image:: https://readthedocs.org/projects/argh/badge/?version=stable
            :target: http://argh.readthedocs.org/en/stable/
        
        .. image:: https://readthedocs.org/projects/argh/badge/?version=latest
            :target: http://argh.readthedocs.org/en/latest/
        
        Building a command-line interface?  Found yourself uttering "argh!" while
        struggling with the API of `argparse`?  Don't like the complexity but need
        the power?
        
        .. epigraph::
        
            Everything should be made as simple as possible, but no simpler.
        
            -- Albert Einstein (probably)
        
        `Argh` is a smart wrapper for `argparse`.  `Argparse` is a very powerful tool;
        `Argh` just makes it easy to use.
        
        In a nutshell
        -------------
        
        `Argh`-powered applications are *simple* but *flexible*:
        
        :Modular:
            Declaration of commands can be decoupled from assembling and dispatching;
        
        :Pythonic:
            Commands are declared naturally, no complex API calls in most cases;
        
        :Reusable:
            Commands are plain functions, can be used directly outside of CLI context;
        
        :Layered:
            The complexity of code raises with requirements;
        
        :Transparent:
            The full power of argparse is available whenever needed;
        
        :Namespaced:
            Nested commands are a piece of cake, no messing with subparsers (though
            they are of course used under the hood);
        
        :Term-Friendly:
            Command output is processed with respect to stream encoding;
        
        :Unobtrusive:
            `Argh` can dispatch a subset of pure-`argparse` code, and pure-`argparse`
            code can update and dispatch a parser assembled with `Argh`;
        
        :DRY:
            The amount of boilerplate code is minimal; among other things, `Argh` will:
        
            * infer command name from function name;
            * infer arguments from function signature;
            * infer argument type from the default value;
            * infer argument action from the default value (for booleans);
            * add an alias root command ``help`` for the ``--help`` argument.
        
        :NIH free:
            `Argh` supports *completion*, *progress bars* and everything else by being
            friendly to excellent 3rd-party libraries.  No need to reinvent the wheel.
        
        Sounds good?  Check the tutorial!
        
        Relation to argparse
        --------------------
        
        `Argh` is fully compatible with `argparse`.  You can mix `Argh`-agnostic and
        `Argh`-aware code.  Just keep in mind that the dispatcher does some extra work
        that a custom dispatcher may not do.
        
        Installation
        ------------
        
        Using pip::
        
            $ pip install argh
        
        Arch Linux (AUR)::
        
            $ yaourt python-argh
        
        Examples
        --------
        
        A very simple application with one command:
        
        .. code-block:: python
        
            import argh
        
            def main():
                return 'Hello world'
        
            argh.dispatch_command(main)
        
        Run it:
        
        .. code-block:: bash
        
            $ ./app.py
            Hello world
        
        A potentially modular application with multiple commands:
        
        .. code-block:: python
        
            import argh
        
            # declaring:
        
            def echo(text):
                "Returns given word as is."
                return text
        
            def greet(name, greeting='Hello'):
                "Greets the user with given name. The greeting is customizable."
                return greeting + ', ' + name
        
            # assembling:
        
            parser = argh.ArghParser()
            parser.add_commands([echo, greet])
        
            # dispatching:
        
            if __name__ == '__main__':
                parser.dispatch()
        
        Of course it works:
        
        .. code-block:: bash
        
            $ ./app.py greet Andy
            Hello, Andy
        
            $ ./app.py greet Andy -g Arrrgh
            Arrrgh, Andy
        
        Here's the auto-generated help for this application (note how the docstrings
        are reused)::
        
            $ ./app.py help
        
            usage: app.py {echo,greet} ...
        
            positional arguments:
                echo        Returns given word as is.
                greet       Greets the user with given name. The greeting is customizable.
        
        ...and for a specific command (an ordinary function signature is converted
        to CLI arguments)::
        
            $ ./app.py help greet
        
            usage: app.py greet [-g GREETING] name
        
            Greets the user with given name. The greeting is customizable.
        
            positional arguments:
              name
        
            optional arguments:
              -g GREETING, --greeting GREETING   'Hello'
        
        (The help messages have been simplified a bit for brevity.)
        
        `Argh` easily maps plain Python functions to CLI.  Sometimes this is not
        enough; in these cases the powerful API of `argparse` is also available:
        
        .. code-block:: python
        
            @arg('text', default='hello world', nargs='+', help='The message')
            def echo(text):
                print text
        
        The approaches can be safely combined even up to this level:
        
        .. code-block:: python
        
            # adding help to `foo` which is in the function signature:
            @arg('foo', help='blah')
            # these are not in the signature so they go to **kwargs:
            @arg('baz')
            @arg('-q', '--quux')
            # the function itself:
            def cmd(foo, bar=1, *args, **kwargs):
                yield foo
                yield bar
                yield ', '.join(args)
                yield kwargs['baz']
                yield kwargs['quux']
        
        Links
        -----
        
        * `Project home page`_ (GitHub)
        * `Documentation`_ (Read the Docs)
        * `Package distribution`_ (PyPI)
        * Questions, requests, bug reports, etc.:
        
          * `Issue tracker`_ (GitHub)
          * `Mailing list`_ (subscribe to get important announcements)
          * Direct e-mail (neithere at gmail com)
        
        .. _project home page: http://github.com/neithere/argh/
        .. _documentation: http://argh.readthedocs.org
        .. _package distribution: http://pypi.python.org/pypi/argh
        .. _issue tracker: http://github.com/neithere/argh/issues/
        .. _mailing list: http://groups.google.com/group/argh-users
        
        Author
        ------
        
        Developed by Andrey Mikhaylenko since 2010.
        
        See file `AUTHORS` for a complete list of contributors to this library.
        
        Support
        -------
        
        The fastest way to improve this project is to submit tested and documented
        patches or detailed bug reports.
        
        Otherwise you can "flattr" me: |FlattrLink|_
        
        .. _FlattrLink: https://flattr.com/submit/auto?user_id=neithere&url=http%3A%2F%2Fpypi.python.org%2Fpypi%2Fargh
        .. |FlattrLink| image:: https://api.flattr.com/button/flattr-badge-large.png
           :alt: Flattr the Argh project
        
        Licensing
        ---------
        
        Argh is free software: you can redistribute it and/or modify
        it under the terms of the GNU Lesser General Public License as published
        by the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.
        
        Argh is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU Lesser General Public License for more details.
        
        You should have received a copy of the GNU Lesser General Public License
        along with Argh.  If not, see <http://gnu.org/licenses/>.
        
Keywords: cli command line argparse optparse argument option
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides: argh