skip to navigation
skip to content

switches 0.1.1

Friendly Command Line Scripts

A user-friendly way to define and process command line scripts.

Usage

example.py:

"""Build commands with switches"""

from switches import command, commandline


@command
def spam(argument1, argument2=None):
    """Print the arguments"""
    print argument1
    if argument2 is not None:
        print argument2


@command
def eggs(argument1=True, argument2=False):
    """Conditionally print the arguments"""
    if argument1:
        print 'argument1 is True'
    if argument2:
        print 'argument2 is True'


if __name__ == '__main__':
    commandline(__doc__)

On the command line:

$ python example.py --help
usage: example.py [-h] {eggs,spam} ...

Build commands with switches

positional arguments:
  {eggs,spam}  commands
    eggs       Conditionally print the arguments
    spam       Print the arguments

optional arguments:
  -h, --help   show this help message and exit

$ python example.py spam --help
usage: example.py spam [-h] [--argument2 ARGUMENT2] argument1

positional arguments:
  argument1

optional arguments:
  -h, --help            show this help message and exit
  --argument2 ARGUMENT2
                        The default value is "None".

$ python example.py eggs --help
usage: example.py eggs [-h] [--argument1 ARGUMENT1] [--argument2 ARGUMENT2]

optional arguments:
  -h, --help            show this help message and exit
  --argument1 ARGUMENT1
                        The default value is "True".
  --argument2 ARGUMENT2
                        The default value is "False".

Full documentation can be found on Read the Docs.

Installation

Installing Switches is easy:

pip install switches

or download the source and run:

python setup.py install
 
File Type Py Version Uploaded on Size
switches-0.1.1.tar.gz (md5) Source 2012-06-13 4KB
  • Author: Andy Dirnberger
  • Home Page: https://github.com/dirn/switches
  • License:
    Copyright (c) 2012, Andy Dirnberger
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without modification,
    are permitted provided that the following conditions are met:
    
        1. Redistributions of source code must retain the above copyright notice,
           this list of conditions and the following disclaimer.
    
        2. Redistributions in binary form must reproduce the above copyright
           notice, this list of conditions and the following disclaimer in the
           documentation and/or other materials provided with the distribution.
    
        3. Neither the name of the project nor the names of its contributors may
           be used to endorse or promote products derived from this software without
           specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Categories
  • Package Index Owner: dirn
  • DOAP record: switches-0.1.1.xml