Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pallets/click

Python composable command line interface toolkit
https://github.com/pallets/click

cli click pallets python

Last synced: 6 days ago
JSON representation

Python composable command line interface toolkit

Awesome Lists containing this project

README 

        
# $ click_



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



## A Simple Example



```python

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 _ in range(count):

        click.echo(f"Hello, {name}!")



if __name__ == '__main__':

    hello()

```



```

$ python hello.py --count=3

Your name: Click

Hello, Click!

Hello, Click!

Hello, Click!

```



## Donate



The Pallets organization develops and supports Click and other popular

packages. In order to grow the community of contributors and users, and

allow the maintainers to devote more time to the projects, [please

donate today][].



[please donate today]: https://palletsprojects.com/donate