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.2.1.tar.gz (286.3 kB view details)

Uploaded Source

Built Distribution

click-8.2.1-py3-none-any.whl (102.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for click-8.2.1.tar.gz
Algorithm Hash digest
SHA256 27c491cc05d968d271d5a1db13e3b5a184636d9d930f148c50b038f0d0646202
MD5 438cfd4974584ae4f960ffeab32e8991
BLAKE2b-256 606c8ca2efa64cf75a977a0d7fac081354553ebe483345c734fb6b6515d96bbc

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: click-8.2.1-py3-none-any.whl
  • Upload date:
  • Size: 102.2 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 61a3265b914e850b85317d0b3109c7f8cd35a670f963866005d6ef1d5175a12b
MD5 aeead16d8bed93caa7107ac87b1e5ec8
BLAKE2b-256 853210bb5764d90a8eee674e9dc6f4db6a0ab47c8c4d0d83c27f7c39ac415a4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for click-8.2.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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page