122 lines
3.4 KiB
Plaintext
122 lines
3.4 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: Click
|
||
|
|
Version: 7.0
|
||
|
|
Summary: Composable command line interface toolkit
|
||
|
|
Home-page: https://palletsprojects.com/p/click/
|
||
|
|
Author: Armin Ronacher
|
||
|
|
Author-email: armin.ronacher@active-4.com
|
||
|
|
Maintainer: Pallets Team
|
||
|
|
Maintainer-email: contact@palletsprojects.com
|
||
|
|
License: BSD
|
||
|
|
Project-URL: Documentation, https://click.palletsprojects.com/
|
||
|
|
Project-URL: Code, https://github.com/pallets/click
|
||
|
|
Project-URL: Issue tracker, https://github.com/pallets/click/issues
|
||
|
|
Platform: UNKNOWN
|
||
|
|
Classifier: Development Status :: 5 - Production/Stable
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: License :: OSI Approved :: BSD License
|
||
|
|
Classifier: Operating System :: OS Independent
|
||
|
|
Classifier: Programming Language :: Python
|
||
|
|
Classifier: Programming Language :: Python :: 2
|
||
|
|
Classifier: Programming Language :: Python :: 2.7
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3.4
|
||
|
|
Classifier: Programming Language :: Python :: 3.5
|
||
|
|
Classifier: Programming Language :: Python :: 3.6
|
||
|
|
Classifier: Programming Language :: Python :: 3.7
|
||
|
|
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
|
||
|
|
|
||
|
|
\$ click\_
|
||
|
|
==========
|
||
|
|
|
||
|
|
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 click
|
||
|
|
|
||
|
|
Click supports Python 3.4 and newer, Python 2.7, and PyPy.
|
||
|
|
|
||
|
|
.. _pip: https://pip.pypa.io/en/stable/quickstart/
|
||
|
|
|
||
|
|
|
||
|
|
A Simple Example
|
||
|
|
----------------
|
||
|
|
|
||
|
|
What does it look like? Here is an example of a simple Click program:
|
||
|
|
|
||
|
|
.. code-block:: python
|
||
|
|
|
||
|
|
import click
|
||
|
|
|
||
|
|
@click.command()
|
||
|
|
@click.option("--count", default=1, help="Number of greetings.")
|
||
|
|
@click.option("--name", prompt="Your name",
|
||
|
|
help="The person to greet.")
|
||
|
|
def hello(count, name):
|
||
|
|
"""Simple program that greets NAME for a total of COUNT times."""
|
||
|
|
for _ in range(count):
|
||
|
|
click.echo("Hello, %s!" % name)
|
||
|
|
|
||
|
|
if __name__ == '__main__':
|
||
|
|
hello()
|
||
|
|
|
||
|
|
And what it looks like when run:
|
||
|
|
|
||
|
|
.. code-block:: text
|
||
|
|
|
||
|
|
$ 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`_.
|
||
|
|
|
||
|
|
.. _please donate today: https://palletsprojects.com/donate
|
||
|
|
|
||
|
|
|
||
|
|
Links
|
||
|
|
-----
|
||
|
|
|
||
|
|
* Website: https://palletsprojects.com/p/click/
|
||
|
|
* Documentation: https://click.palletsprojects.com/
|
||
|
|
* License: `BSD <https://github.com/pallets/click/blob/master/LICENSE.rst>`_
|
||
|
|
* 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
|
||
|
|
|
||
|
|
|