trio-click 7.0.dev5

A simple trio-compatible wrapper around optparse for powerful command line utilities.

\$ trio-click\_
==============

What's Trio-Click?
------------------

Trio-Click ist a fork of Click that works well with Trio.

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.

Click in three points:
- arbitrary nesting of commands
- automatic help page generation
- supports lazy loading of subcommands at runtime

Installing
----------

Install and update using `pip`_:

.. code-block:: text

$ pip install trio-click

Trio-Click supports Python 3.5 and newer, and PyPy3.

A Simple Example
----------------

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

.. code-block:: python

import trio
import trio_click 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 x in range(count):
if x: await trio.sleep(0.1)
click.echo('Hello %s!' % name)

if __name__ == '__main__':
hello()

.. note::
Trio-Click automagically starts a Trio event loop and runs your
code asynchronously.

And what it looks like when run:

.. code-block:: text

$ python hello.py --count=3
Your name: John
Hello John!
Hello John!
Hello John!

Donate
------

The Pallets organization develops and supports Flask and the libraries
it uses. In order to grow the community of contributors and users, and
allow the maintainers to devote more time to the projects, `please
donate today`_.

.. _please donate today: https://psfmember.org/civicrm/contribute/transact?reset=1&id=20

The Trio-Click fork is maintained by Matthias Urlichs <[e-mail]>.
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. ;-)

Links
-----

* Website: https://www.palletsprojects.com/p/click/
* Documentation: http://click.pocoo.org/
* License: `BSD <https://github.com/pallets/click/blob/master/LICENSE>`_
* Releases: https://pypi.org/project/click/
* Code: https://github.com/pallets/click
* Issue tracker: https://github.com/pallets/click/issues
* Test status:

* Linux, Mac: https://travis-ci.org/pallets/click
* Windows: https://ci.appveyor.com/project/pallets/click

* Test coverage: https://codecov.io/gh/pallets/click

.. _pip: https://pip.pypa.io/en/stable/quickstart/