fastcommand

Python module for defining multi-command cli programs

Description

The fastcommand module is a lightweight wrapper over argparse which aims to make it easier to write multi-command cli programs and utilities. It does so by providing convenience decorators that allow for quickly defining sub-commands.

Usage

Example

import fastcommand


@fastcommand.command("hello", help="say hello")
def command_hello(options):
    print("Hello, World!")


@fastcommand.command("goodbye", help="say goodbye", arguments=[
    fastcommand.Argument("name"),
    fastcommand.Argument("--wave", "-w", action="store_true", default=False)
])
def command_goodbye(options):
    print(f"Goodbye, {options.name}!")
    if options.wave:
        print("👋")


def main():
    cli = fastcommand.CommandParser(description="Simple fastcommand example.")
    cli.use_logging(format="[%(levelname)s] %(message)s")
    cli.run()


if __name__ == "__main__":
    main()

Autocomplete

fastcommand provides autocomplete using argcomplete. Enable it by adding the following the argcomplete marker to the to of your application:

# PYTHON_ARGCOMPLETE_OK

Install argcomplete locally to be able to use autocomplete:

pip install argcomplete

And then either:

• activate globally by running:

  activate-global-python-argcomplete
  

• activate it for a specific command by running:

  eval "$(register-python-argcomplete my-python-app)"
  

See the argcomplete documentation for more details.