asynccli
A CLI framework based on asyncio.
Note
This is still in active development. Things will change. For now, the basic framework is operational. If you are interested in helping out, or would like to see any particular features added, let me know.
Usage
The simplest usage is to just pass in an async function.
import asynccli
async def mycli():
print("Hello, world.")
if __name__ == '__main__':
app = asynccli.App(mycli)
app.run()
It can also be instantiated as a class, as long it has a call method.
import asynccli
class DivisionCalculator(asynccli.CLI):
numerator = asynccli.Integer(help_text='This is the numerator.')
denominator = asynccli.Integer()
async def call(self):
print(self.first_num / self.second_num)
if __name__ == '__main__':
app = asynccli.App(DivisionCalculator)
app.run()
In the DivisionCalculator example above, you would call your script like this:
$ /path/to/script.py 2 3 0.6666666666666666
What if you want to have a tiered CLI with a hierarchy of commands? First, create your command by subclassing CLI as above. Then, wrap the whole thing inside of the TieredCLI class, and pass that to the App.
class Calculator(asynccli.TieredCLI):
d = DivisionCalculator
if __name__ == '__main__':
app = asynccli.App(Calculator)
app.run()
Now, to invoke the script, you have an extra argument to call:
$ /path/to/script.py d 2 3 0.6666666666666666
Installation
pip install asynccli
Requirements
Currently it requires Python 3.5 to make use of async/await. It uses argparse under the hood, and therefore has no dependencies outside of the standard library.
Roadmap
- Additional
Argumenttypes - Integration of additional
argparsefeatures - Add
uvloop - Better support for help documentation
Testing
You can invoke the test scripts a few different ways:
$ py.test $ python setup.py test $ python -m py.test
And, in order to generate the test coverage:
$ coverage run -m py.test
License
Authors
asynccli was written by Adam Hopkins.
0 Nov 22, 2021
16 Oct 15, 2022
7 Aug 13, 2022
1 Dec 1, 2021
8 Dec 13, 2022
2 Jul 15, 2022
2 Jan 10, 2022
3 Feb 14, 2022
1 Jan 16, 2022
14 Sep 11, 2022
2 Dec 10, 2021
1 Nov 5, 2021
1 Feb 5, 2022
4 Aug 4, 2022
166 Dec 30, 2022
17 Dec 11, 2022
14 May 23, 2022