METADATA 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. Metadata-Version: 2.4
  2. Name: click
  3. Version: 8.3.0
  4. Summary: Composable command line interface toolkit
  5. Maintainer-email: Pallets <contact@palletsprojects.com>
  6. Requires-Python: >=3.10
  7. Description-Content-Type: text/markdown
  8. License-Expression: BSD-3-Clause
  9. Classifier: Development Status :: 5 - Production/Stable
  10. Classifier: Intended Audience :: Developers
  11. Classifier: Operating System :: OS Independent
  12. Classifier: Programming Language :: Python
  13. Classifier: Typing :: Typed
  14. License-File: LICENSE.txt
  15. Requires-Dist: colorama; platform_system == 'Windows'
  16. Project-URL: Changes, https://click.palletsprojects.com/page/changes/
  17. Project-URL: Chat, https://discord.gg/pallets
  18. Project-URL: Documentation, https://click.palletsprojects.com/
  19. Project-URL: Donate, https://palletsprojects.com/donate
  20. Project-URL: Source, https://github.com/pallets/click/
  21. <div align="center"><img src="https://raw.githubusercontent.com/pallets/click/refs/heads/stable/docs/_static/click-name.svg" alt="" height="150"></div>
  22. # Click
  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. ## A Simple Example
  35. ```python
  36. import click
  37. @click.command()
  38. @click.option("--count", default=1, help="Number of greetings.")
  39. @click.option("--name", prompt="Your name", help="The person to greet.")
  40. def hello(count, name):
  41. """Simple program that greets NAME for a total of COUNT times."""
  42. for _ in range(count):
  43. click.echo(f"Hello, {name}!")
  44. if __name__ == '__main__':
  45. hello()
  46. ```
  47. ```
  48. $ python hello.py --count=3
  49. Your name: Click
  50. Hello, Click!
  51. Hello, Click!
  52. Hello, Click!
  53. ```
  54. ## Donate
  55. The Pallets organization develops and supports Click and other popular
  56. packages. In order to grow the community of contributors and users, and
  57. allow the maintainers to devote more time to the projects, [please
  58. donate today][].
  59. [please donate today]: https://palletsprojects.com/donate
  60. ## Contributing
  61. See our [detailed contributing documentation][contrib] for many ways to
  62. contribute, including reporting issues, requesting features, asking or answering
  63. questions, and making PRs.
  64. [contrib]: https://palletsprojects.com/contributing/