asyncclick 7.0.9

A simple anyio-compatible fork of Click, for powerful command line utilities.

What’s AsyncClick?

AsyncClick ist a fork of Click that works well with trio, asyncio, or curio.

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.

AsyncClick in four points:

• Arbitrary nesting of commands
• Automatic help page generation
• Supports lazy loading of subcommands at runtime
• Seamlessly use async-enabled command and subcommand handlers

Installing

Install and update using pip:

$ pip install asyncclick

AsyncClick supports Python 3.5 and newer, and PyPy3.

A Simple Example

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

import anyio
import asyncclick as click

@click.command()
@click.option("--count", default=1, help="Number of greetings.")
@click.option("--name", prompt="Your name",
              help="The person to greet.")
async def hello(count, name):
    """Simple program that greets NAME for a total of COUNT times."""
    for x in range(count):
        if x: await anyio.sleep(0.1)
        click.echo("Hello, %s!" % name)

if __name__ == '__main__':
    hello(_anyio_backend="trio")  # or asyncio, or curio

Note

AsyncClick automagically starts an anyio event loop and runs your code asynchronously.

And what it looks like when run:

$ 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.

The AsyncClick fork is maintained by Matthias Urlichs <[e-mail]>. It’s not a lot of work, so if you’d like to motivate me, donate to the charity of your choice and tell me that you’ve done so. ;-)

Links

These links point to the original, non-async-enabled, version of Click.

• Website: https://palletsprojects.com/p/click/
• Documentation: https://click.palletsprojects.com/
• License: BSD
• Releases: https://pypi.org/project/click/
• Code: https://github.com/pallets/click
• Issue tracker: https://github.com/pallets/click/issues
• Test status:
  • Linux, Mac: https://travis-ci.org/pallets/click
  • Windows: https://ci.appveyor.com/project/pallets/click
• Test coverage: https://codecov.io/gh/pallets/click

The issue tracker for the async version is at https://github.com/click-contrib/asyncclick/issues .