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.4.2.tar.gz (338.0 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.4.2-py3-none-any.whl (119.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for click-8.4.2.tar.gz
Algorithm Hash digest
SHA256 9a6cea6e60b17ebe0a44c5cc636d94f09bd66142c1cd7d8b4cd731c4917a15f6
MD5 e35da284dc6420c59c1885ccb22d9879
BLAKE2b-256 76d481420972a676e8ffea40450d8c8c92943e7218a78fe9b64359836cc9876b

See more details on using hashes here.

Provenance

The following attestation bundles were made for click-8.4.2.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.4.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for click-8.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e6f9f66136c816745b9d65817da91d61d957fb16e02e4dcd0552553c5a197b76
MD5 54ca40e656d5b0bb505ce76fd40efe39
BLAKE2b-256 fbe279c688af8b210d232694e31e59da9f6ec747bae31c3f5946e4e9b98860d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for click-8.4.2-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