diff options
author | David Lord <davidism@gmail.com> | 2018-09-24 08:21:11 -0700 |
---|---|---|
committer | David Lord <davidism@gmail.com> | 2018-09-24 08:36:28 -0700 |
commit | e8bf968c8f26231d7c2a6d04ac83c81199bb607f (patch) | |
tree | 58c41a49915bdb0c012cc89697c9bb0bb017277f /README.rst | |
parent | a589835a5b656eec4bace076ac7e947662c1cc68 (diff) | |
download | click-e8bf968c8f26231d7c2a6d04ac83c81199bb607f.tar.gz |
update metadata
test on 3.7
fix collections deprecation warning
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 34 |
1 files changed, 17 insertions, 17 deletions
@@ -2,8 +2,8 @@ ========== 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 +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 @@ -12,9 +12,9 @@ implement an intended CLI API. Click in three points: -- arbitrary nesting of commands -- automatic help page generation -- supports lazy loading of subcommands at runtime +- Arbitrary nesting of commands +- Automatic help page generation +- Supports lazy loading of subcommands at runtime Installing @@ -41,13 +41,13 @@ 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.') + @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('Hello %s!' % name) + for _ in range(count): + click.echo("Hello, %s!" % name) if __name__ == '__main__': hello() @@ -57,17 +57,17 @@ And what it looks like when run: .. code-block:: text $ python hello.py --count=3 - Your name: John - Hello John! - Hello John! - Hello John! + Your name: Click + Hello, Click! + Hello, Click! + Hello, Click! Donate ------ -The Pallets organization develops and supports Flask and the libraries -it uses. In order to grow the community of contributors and users, and +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`_. @@ -79,7 +79,7 @@ Links * Website: https://palletsprojects.com/p/click/ * Documentation: https://click.palletsprojects.com/ -* License: `BSD <https://github.com/pallets/click/blob/master/LICENSE>`_ +* License: `BSD <https://github.com/pallets/click/blob/master/LICENSE.rst>`_ * Releases: https://pypi.org/project/click/ * Code: https://github.com/pallets/click * Issue tracker: https://github.com/pallets/click/issues |