ClickClick Utility Functions

20.10.2 · maintenance · verified Thu Apr 09

ClickClick (v20.10.2) provides common helper functionality for Click-based Command Line Interfaces (CLIs), such as formatted output (tables, colored messages), terminal diffs, progress bars, and aliased command groups. It is currently in maintenance mode with infrequent releases; the last major release was in October 2020.

Warnings

gotcha ClickClick has been in maintenance mode since its last release in October 2020. While stable, new features for `click` or significant API changes in `click` might not be immediately supported or integrated.
Fix: Be aware that active development is limited. For the latest `click` features or active support, consider other alternatives if `clickclick` utilities don't meet requirements.
gotcha The library depends on `six` for Python 2/3 compatibility. For Python 3-only projects, this dependency is often unnecessary and adds a potentially unused package to your environment.
Fix: There is no direct fix for removing `six` as it's a hard dependency, but acknowledge its presence and that it's largely inert for Python 3 environments.
gotcha ClickClick does not specify a strict version range for its `click` dependency. While generally robust, this could theoretically lead to compatibility issues with very old or very new `click` versions if `clickclick`'s internal assumptions about `click`'s API diverge.
Fix: Ensure your `click` version is relatively current and compatible with the `clickclick` release. Test your application thoroughly after `click` upgrades. If issues arise, try pinning `click` to a version known to work.

Install

pip install clickclick Install latest version

Imports

print_table
```
from clickclick import print_table
```
Common function for printing formatted tables to the console.
print_info
```
from clickclick import print_info
```
For printing colored informational messages. Also print_warning, print_error, print_success.
AliasedGroup
```
from clickclick import AliasedGroup
```
Allows defining aliases for Click commands.

Quickstart

This quickstart demonstrates how to use `clickclick.print_table` within a simple Click CLI application to output structured data to the console with proper formatting. Run this script as a Python file to see the output.

import click
from clickclick import print_table

@click.command()
def main():
    """Example CLI using clickclick's print_table."""
    click.echo("Fetching data...")
    headers = ['ID', 'Name', 'Status']
    rows = [
        {'ID': 1, 'Name': 'Task A', 'Status': 'Done'},
        {'ID': 2, 'Name': 'Task B', 'Status': 'Pending'},
        {'ID': 3, 'Name': 'Task C', 'Status': 'Error'}
    ]
    print_table(headers, rows, max_column_width=40)
    click.echo("Table printed.")

if __name__ == '__main__':
    main()

view raw JSON →