METADATA 2.8 KB

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