Navigation

Click is a Python package for creating beautiful command line interfaces
in a composable way with as little code as necessary. It’s the “Command
Line Interface Creation Kit”. It’s highly configurable but comes with
sensible defaults out of the box.

It aims to make the process of writing command line tools quick and fun
while also preventing any frustration caused by the inability to implement
an intended CLI API.

Click in three points:

arbitrary nesting of commands

automatic help page generation

supports lazy loading of subcommands at runtime

What does it look like? Here is an example of a simple Click program:

importclick@click.command()@click.option('--count',default=1,help='Number of greetings.')@click.option('--name',prompt='Your name',help='The person to greet.')defhello(count,name):"""Simple program that greets NAME for a total of COUNT times."""forxinrange(count):click.echo('Hello %s!'%name)if__name__=='__main__':hello()

$ python hello.py --help
Usage: hello [OPTIONS]
Simple program that greets NAME for a total of COUNT times.
Options:
--count INTEGER Number of greetings.
--name TEXT The person to greet.
--help Show this message and exit.