METADATA 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. Metadata-Version: 2.1
  2. Name: click
  3. Version: 8.1.7
  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: Donate, https://palletsprojects.com/donate
  10. Project-URL: Documentation, https://click.palletsprojects.com/
  11. Project-URL: Changes, https://click.palletsprojects.com/changes/
  12. Project-URL: Source Code, https://github.com/pallets/click/
  13. Project-URL: Issue Tracker, https://github.com/pallets/click/issues/
  14. Project-URL: Chat, https://discord.gg/pallets
  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. Requires-Python: >=3.7
  21. Description-Content-Type: text/x-rst
  22. License-File: LICENSE.rst
  23. Requires-Dist: colorama ; platform_system == "Windows"
  24. Requires-Dist: importlib-metadata ; python_version < "3.8"
  25. \$ click\_
  26. ==========
  27. Click is a Python package for creating beautiful command line interfaces
  28. in a composable way with as little code as necessary. It's the "Command
  29. Line Interface Creation Kit". It's highly configurable but comes with
  30. sensible defaults out of the box.
  31. It aims to make the process of writing command line tools quick and fun
  32. while also preventing any frustration caused by the inability to
  33. implement an intended CLI API.
  34. Click in three points:
  35. - Arbitrary nesting of commands
  36. - Automatic help page generation
  37. - Supports lazy loading of subcommands at runtime
  38. Installing
  39. ----------
  40. Install and update using `pip`_:
  41. .. code-block:: text
  42. $ pip install -U click
  43. .. _pip: https://pip.pypa.io/en/stable/getting-started/
  44. A Simple Example
  45. ----------------
  46. .. code-block:: python
  47. import click
  48. @click.command()
  49. @click.option("--count", default=1, help="Number of greetings.")
  50. @click.option("--name", prompt="Your name", help="The person to greet.")
  51. def hello(count, name):
  52. """Simple program that greets NAME for a total of COUNT times."""
  53. for _ in range(count):
  54. click.echo(f"Hello, {name}!")
  55. if __name__ == '__main__':
  56. hello()
  57. .. code-block:: text
  58. $ python hello.py --count=3
  59. Your name: Click
  60. Hello, Click!
  61. Hello, Click!
  62. Hello, Click!
  63. Donate
  64. ------
  65. The Pallets organization develops and supports Click and other popular
  66. packages. In order to grow the community of contributors and users, and
  67. allow the maintainers to devote more time to the projects, `please
  68. donate today`_.
  69. .. _please donate today: https://palletsprojects.com/donate
  70. Links
  71. -----
  72. - Documentation: https://click.palletsprojects.com/
  73. - Changes: https://click.palletsprojects.com/changes/
  74. - PyPI Releases: https://pypi.org/project/click/
  75. - Source Code: https://github.com/pallets/click
  76. - Issue Tracker: https://github.com/pallets/click/issues
  77. - Chat: https://discord.gg/pallets