Git Product home page Git Product logo

asyncclick's Introduction

asyncclick

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

A Simple Example

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 _ in range(count):
        if x: await anyio.sleep(0.1)
        click.echo(f"Hello, {name}!")

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

Note

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

$ 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 <[email protected]>. 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. ;-)

AsyncClick is sufficiently minimal to not have its own web page.

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

asyncclick's People

Contributors

amy-lei avatar cataman avatar davidism avatar dependabot-preview[bot] avatar dependabot[bot] avatar epequeno avatar ikeviny avatar jab avatar janluke avatar jcrotts avatar jdufresne avatar josiahdub avatar julen avatar jwodder avatar jzengg avatar kporangehat avatar mitsuhiko avatar pre-commit-ci[bot] avatar quobit avatar rsiemens avatar saif807380 avatar segevfiner avatar sirosen avatar sjagoe avatar slafs avatar smurfix avatar stopthatcow avatar untitaker avatar yourun-proger avatar zacbir avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

frkl-io makkus

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.