Skip to main content

Friendly Command Line Scripts

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

switches-0.1.1.tar.gz (4.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page