METADATA 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. Metadata-Version: 2.1
  2. Name: Click
  3. Version: 7.0
  4. Summary: Composable command line interface toolkit
  5. Home-page: https://palletsprojects.com/p/click/
  6. Author: Armin Ronacher
  7. Author-email: armin.ronacher@active-4.com
  8. Maintainer: Pallets Team
  9. Maintainer-email: contact@palletsprojects.com
  10. License: BSD
  11. Project-URL: Documentation, https://click.palletsprojects.com/
  12. Project-URL: Code, https://github.com/pallets/click
  13. Project-URL: Issue tracker, https://github.com/pallets/click/issues
  14. Platform: UNKNOWN
  15. Classifier: Development Status :: 5 - Production/Stable
  16. Classifier: Intended Audience :: Developers
  17. Classifier: License :: OSI Approved :: BSD License
  18. Classifier: Operating System :: OS Independent
  19. Classifier: Programming Language :: Python
  20. Classifier: Programming Language :: Python :: 2
  21. Classifier: Programming Language :: Python :: 2.7
  22. Classifier: Programming Language :: Python :: 3
  23. Classifier: Programming Language :: Python :: 3.4
  24. Classifier: Programming Language :: Python :: 3.5
  25. Classifier: Programming Language :: Python :: 3.6
  26. Classifier: Programming Language :: Python :: 3.7
  27. Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
  28. \$ click\_
  29. ==========
  30. Click is a Python package for creating beautiful command line interfaces
  31. in a composable way with as little code as necessary. It's the "Command
  32. Line Interface Creation Kit". It's highly configurable but comes with
  33. sensible defaults out of the box.
  34. It aims to make the process of writing command line tools quick and fun
  35. while also preventing any frustration caused by the inability to
  36. implement an intended CLI API.
  37. Click in three points:
  38. - Arbitrary nesting of commands
  39. - Automatic help page generation
  40. - Supports lazy loading of subcommands at runtime
  41. Installing
  42. ----------
  43. Install and update using `pip`_:
  44. .. code-block:: text
  45. $ pip install click
  46. Click supports Python 3.4 and newer, Python 2.7, and PyPy.
  47. .. _pip: https://pip.pypa.io/en/stable/quickstart/
  48. A Simple Example
  49. ----------------
  50. What does it look like? Here is an example of a simple Click program:
  51. .. code-block:: python
  52. import click
  53. @click.command()
  54. @click.option("--count", default=1, help="Number of greetings.")
  55. @click.option("--name", prompt="Your name",
  56. help="The person to greet.")
  57. def hello(count, name):
  58. """Simple program that greets NAME for a total of COUNT times."""
  59. for _ in range(count):
  60. click.echo("Hello, %s!" % name)
  61. if __name__ == '__main__':
  62. hello()
  63. And what it looks like when run:
  64. .. code-block:: text
  65. $ python hello.py --count=3
  66. Your name: Click
  67. Hello, Click!
  68. Hello, Click!
  69. Hello, Click!
  70. Donate
  71. ------
  72. The Pallets organization develops and supports Click and other popular
  73. packages. In order to grow the community of contributors and users, and
  74. allow the maintainers to devote more time to the projects, `please
  75. donate today`_.
  76. .. _please donate today: https://palletsprojects.com/donate
  77. Links
  78. -----
  79. * Website: https://palletsprojects.com/p/click/
  80. * Documentation: https://click.palletsprojects.com/
  81. * License: `BSD <https://github.com/pallets/click/blob/master/LICENSE.rst>`_
  82. * Releases: https://pypi.org/project/click/
  83. * Code: https://github.com/pallets/click
  84. * Issue tracker: https://github.com/pallets/click/issues
  85. * Test status:
  86. * Linux, Mac: https://travis-ci.org/pallets/click
  87. * Windows: https://ci.appveyor.com/project/pallets/click
  88. * Test coverage: https://codecov.io/gh/pallets/click