1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
.. rst-class:: hide-header
.. image:: _static/click-logo.png
Welcome to the AsyncClick Documentation
=======================================
.. image:: _static/click-name.svg
:align: center
:height: 200px
AsyncClick is 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.
Click in three points:
- arbitrary nesting of commands
- automatic help page generation
- supports lazy loading of subcommands at runtime
What does it look like? Here is an example of a simple Click program:
.. click:example::
import asyncclick as click
import anyio
@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()
And what it looks like when run:
.. click:run::
invoke(hello, ['--count=3'], prog_name='python hello.py', input='John\n')
It automatically generates nicely formatted help pages:
.. click:run::
invoke(hello, ['--help'], prog_name='python hello.py')
You can get the library directly from PyPI::
pip install asyncclick
Documentation
==============
.. toctree::
:maxdepth: 2
faqs
Tutorials
------------
.. toctree::
:maxdepth: 1
quickstart
virtualenv
How to Guides
---------------
.. toctree::
:maxdepth: 1
entry-points
setuptools
support-multiple-versions
Conceptual Guides
-------------------
.. toctree::
:maxdepth: 1
why
click-concepts
General Reference
--------------------
.. toctree::
:maxdepth: 1
parameters
parameter-types
options
option-decorators
arguments
commands-and-groups
commands
documentation
prompts
handling-files
advanced
complex
extending-click
testing
utils
shell-completion
exceptions
unicode-support
wincmd
API Reference
-------------------
.. toctree::
:maxdepth: 2
api
About Project
===============
* This documentation is structured according to `Diataxis <https://diataxis.fr/>`_
* `Version Policy <https://palletsprojects.com/versions>`_
* `Contributing <https://palletsprojects.com/contributing/>`_
* `Donate <https://palletsprojects.com/donate>`_
.. toctree::
:maxdepth: 1
contrib
license
changes
|
