Coolest command-line interface on this planet
Project description
Convert your ordinary functions into cool command-line interfaces!
Komandr is a smart thin wrapper around powerful argparse module lets you build defacto standart command-line interfaces in secondz while providing you all the flexibity.
Example
# example.py from komandr import * # straigforward ad-hoc usage @command def foo(bar, baz=None): print 'foo', bar, baz # but also it allows you much more tuning @command(name='cool_command_name') @arg('baz', '-z', required=True, type=int) def lame_command_name(foo, bar, baz=1): print 'lame_command_name', foo, bar, baz if __name__ == '__main__': main()
Need some help?:
$ python example.py --help usage: example.py [-h] [-v] {foo,cool_command_name} ... positional arguments: {foo,cool_command_name} optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit
Let’s investigate more about foo:
$ python example.py foo --help usage: example.py foo [-h] --baz BAZ bar positional arguments: bar optional arguments: -h, --help show this help message and exit --baz BAZ
Test foo command:
$ python example.py foo Hello usage: example.py foo [-h] --baz BAZ bar example.py foo: error: argument --baz is required
That’s ok now:
$ python example.py foo Hello --baz World foo Hello World
Cool, eh?
This also shows how flexible and configurable it is:
$ python example.py cool_command_name Hello -z 'Non numeric' World usage: example.py cool_command_name [-h] --baz BAZ foo bar example.py cool_command_name: error: argument --baz/-z: invalid int value: 'Non Numeric'
Correct one should be:
$ python example.py cool_command_name Hello -z 2013 World lame_command_name Hello World 2013
Enjoy!
Licence
Copyright (c) 2012 Kadir Pekel.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.