Skip to main content

Composable command line interface toolkit, async version

Project description

What’s AsyncClick?

AsyncClick is a fork of Click that works well with trio or asyncio.

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.7 and newer, and PyPy3.

A Simple Example

import anyio
import asyncclick as click
# You can use all of click's features as per its documentation.
# Async commands are supported seamlessly; they just work.

@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(f"Hello, {name}!")

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

# You can use your own event loop:
#    import anyio
#    async def main():
#        await hello.main()
#    if __name__ == '__main__':
#        anyio.run(main)
# This is useful for testing.
$ python hello.py --count=3
Your name: Click
Hello, Click!
Hello, Click!
Hello, Click!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asyncclick-8.1.7.2.tar.gz (349.1 kB view details)

Uploaded Source

Built Distribution

asyncclick-8.1.7.2-py3-none-any.whl (99.2 kB view details)

Uploaded Python 3

File details

Details for the file asyncclick-8.1.7.2.tar.gz.

File metadata

  • Download URL: asyncclick-8.1.7.2.tar.gz
  • Upload date:
  • Size: 349.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for asyncclick-8.1.7.2.tar.gz
Algorithm Hash digest
SHA256 219ea0f29ccdc1bb4ff43bcab7ce0769ac6d48a04f997b43ec6bee99a222daa0
MD5 542e83089a55129ca2fe7ccdbc65ba77
BLAKE2b-256 5ebf59d836c3433d7aa07f76c2b95c4eb763195ea8a5d7f9ad3311ed30c2af61

See more details on using hashes here.

File details

Details for the file asyncclick-8.1.7.2-py3-none-any.whl.

File metadata

  • Download URL: asyncclick-8.1.7.2-py3-none-any.whl
  • Upload date:
  • Size: 99.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for asyncclick-8.1.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1ab940b04b22cb89b5b400725132b069d01b0c3472a9702c7a2c9d5d007ded02
MD5 49632e6ec71c943f612faaf7722be1ed
BLAKE2b-256 1e6e9acdbb25733e1de411663b59abe521bec738e72fe4e85843f6ff8b212832

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page