Welcome to the AsyncClick Documentation

_images/click-logo.png

AsyncClick ist a fork of Click that works well with (some) async frameworks. Supported: asyncio, trio, and curio.

Click, in turn, 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

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

And what it looks like when run:

It automatically generates nicely formatted help pages:

You can get the library directly from PyPI:

pip install asyncclick

Documentation

Note

asyncclick closely tracks click’s releases and development. In order to streamline this process, the documentation was changed as lightly as possible. Thus, the author decided not to mangle the text and did not replace click with asyncclick.

Please adjust all import click statements to import asyncclick as click, or apply similar changes, as required.

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.