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.0.tar.gz (276.9 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.0-py3-none-any.whl (107.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: click-8.3.0.tar.gz
  • Upload date:
  • Size: 276.9 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.0.tar.gz
Algorithm Hash digest
SHA256 e7b8232224eba16f4ebe410c25ced9f7875cb5f3263ffc93cc3e8da705e229c4
MD5 fa228744ff03a339957e847fb7890823
BLAKE2b-256 4661de6cd827efad202d7057d93e0fed9294b96952e188f7384832791c7b2254

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: click-8.3.0-py3-none-any.whl
  • Upload date:
  • Size: 107.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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b9f285302c6e3064f4330c05f05b81945b2a39544279343e6e7c5f27a9baddc
MD5 dd99757a403a5728bb37a5cab4d46c83
BLAKE2b-256 dbd39dcc0f5797f070ec8edf30fbadfb200e71d9db6b84d211e3b2085a7589a0

See more details on using hashes here.

Provenance

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