Skip to main content

Composable command line interface toolkit

Project description

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

A Simple Example

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(f"Hello, {name}!")

if __name__ == '__main__':
    hello()
$ 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.

Contributing

See our detailed contributing documentation for many ways to contribute, including reporting issues, requesting features, asking or answering questions, and making PRs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

click-8.3.1.tar.gz (295.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

click-8.3.1-py3-none-any.whl (108.3 kB view details)

Uploaded Python 3

File details

Details for the file click-8.3.1.tar.gz.

File metadata

  • Download URL: click-8.3.1.tar.gz
  • Upload date:
  • Size: 295.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for click-8.3.1.tar.gz
Algorithm Hash digest
SHA256 12ff4785d337a1bb490bb7e9c2b1ee5da3112e94a8622f26a6c77f5d2fc6842a
MD5 5f89d725a424b101607ec40927f78773
BLAKE2b-256 3dfa656b739db8587d7b5dfa22e22ed02566950fbfbcdc20311993483657a5c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for click-8.3.1.tar.gz:

Publisher: publish.yaml on pallets/click

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file click-8.3.1-py3-none-any.whl.

File metadata

  • Download URL: click-8.3.1-py3-none-any.whl
  • Upload date:
  • Size: 108.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for click-8.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 981153a64e25f12d547d3426c367a4857371575ee7ad18df2a6183ab0545b2a6
MD5 f032502934a5979330da77e3f09d889c
BLAKE2b-256 987801c019cdb5d6498122777c1a43056ebb3ebfeef2076d9d026bfe15583b2b

See more details on using hashes here.

Provenance

The following attestation bundles were made for click-8.3.1-py3-none-any.whl:

Publisher: publish.yaml on pallets/click

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page