pyminiCLI 0.2.1

quick and easy command-line interfaces

pyminiCLI

the quickest and simplest way to specify command-line interfaces for python scripts and apps.

how it works

simply call minicli.command on a function in your script, and its positional arguments will be interpereted as command-line positionals, its keywords as command-line options, and its docstring used to supplement the usage in --help

in example.py:

from minicli import command


def a_function(positional1, *args, keyword_only, kwarg='blarg'):
    """
    a docstring
    :param positional1: the first positional argument
    :param: *args: any number of other arguments
    :param keyword_only: non-optional -- argument
    :param kwarg: an option
    """
    print("Hello!")
    print('I recieved positional: ', positional1)
    print('required keyword:, ' keyword_only)
    print('other positionals: ', *args)
    print('my options are: ', kwarg)
    return


command(a_function)
# should have usage, followed by docstring as help
# all positionals should be passed in order
# all options as keywords

the result:

$ python example.py a b c d e --keyword_only b --kwarg z
Hello!
I recieved positional:  a
required keyword:  b
other positionals:  b c d e
my options are:  z


$ python example.py --help
usage:  positional1 <args... > [--keyword_only <value> (required)]  [--kwarg <value>] 

    a docstring
    :param positional1: the first positional argument
    :param: *args: any number of other arguments
    :param keyword_only: non-optional -- argument
    :param kwarg: an option

Contributing

If you would like to add to pyminiCLI:

1. make an issue explaining what improvment you would like to make
2. create a pull request

see below for ideas for what to improve

To do

• boolean options
• one-letter flags
• multiple named commands in the same python app
• include type hints in --help
• cast arguments to type hint types
• automatically include defaults in doc
• still work if options provided before positionals
• **kwargs