 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. Show 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:
What does it look like? Here is an example of a simple Click program: import click @click.command() @click.option('--count', default=1, help='Number of greetings.') @click.option('--name', prompt='Your name', help='The person to greet.') def hello(count, name): """Simple program that greets NAME for a total of COUNT times.""" for x in range(count): click.echo(f"Hello {name}!") if __name__ == '__main__': hello() And what it looks like when run: $ python hello.py --count=3 Your name: John Hello John! Hello John! Hello John! It automatically generates nicely formatted help pages: $ python hello.py --help Usage: hello.py [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. You can get the library directly from PyPI: Documentation¶This part of the documentation guides you through all of the library’s usage patterns.
API Reference¶If you are looking for information on a specific function, class, or method, this part of the documentation is for you.
Miscellaneous Pages¶
What is Click option in Python?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.
How do I install a click library in Python?How to Install click on Windows?. Type "cmd" in the search bar and hit Enter to open the command line. ... . Type “ pip install click ” (without quotes) in the command line and hit Enter again. ... . The previous command may not work if you have both Python versions 2 and 3 on your computer.. What is click Pass_context?When a Click command callback is executed, it's passed all the non-hidden parameters as keyword arguments. Notably absent is the context. However, a callback can opt into being passed to the context object by marking itself with pass_context() .
|
