click-didyoumean

0.3.1 · active · verified Sat Mar 28

This library enables a 'did-you-mean' suggestion feature, similar to Git, for Click-based command-line interfaces. It provides an extended `Group` and `CommandCollection` class to automatically suggest correct commands for mistyped inputs. It is currently at version 0.3.1 and is infrequently updated.

Warnings

gotcha When combining multiple Click group sources, you must use `DYMCommandCollection` instead of `DYMGroup`.
Fix: Instead of decorating a group, create an instance of `DYMCommandCollection` and pass your existing `click.Group` objects as `sources`. Example: `cli = DYMCommandCollection(sources=[cli1, cli2])`.
gotcha The default number of suggestions (max_suggestions) and similarity cutoff (cutoff) might not be ideal for all applications.
Fix: You can configure `max_suggestions` (default 3) and `cutoff` (default 0.5) when initializing `DYMGroup` or `DYMCommandCollection` to fine-tune the suggestion behavior. For example: `@click.group(cls=DYMGroup, max_suggestions=5, cutoff=0.7)`.
gotcha The library relies on Click's internal group and command handling. Major updates to Click could potentially introduce breaking changes in how these extensions integrate.
Fix: Always test `click-didyoumean` functionality after upgrading `Click` to a new major version. Keep `click-didyoumean` updated to its latest release.
gotcha The library officially supports Python 3.8 and above, as indicated in its `pyproject.toml`.
Fix: Ensure your project uses Python 3.8 or newer. While older PyPI metadata might suggest Python >=3.6.2, the current development points to 3.8+.

Install

pip install click-didyoumean Install stable version

Imports

DYMGroup
```
from click_didyoumean import DYMGroup
```
Use this to add 'did-you-mean' functionality to a single Click group.
DYMCommandCollection
```
from click_didyoumean import DYMCommandCollection
```
Use this for CLIs composed of multiple Click group sources (CommandCollection).

Quickstart

To enable the 'did-you-mean' feature, simply pass `cls=DYMGroup` to your `click.group` decorator. For more complex applications using `CommandCollection`, substitute `DYMCommandCollection`.

import click
from click_didyoumean import DYMGroup

@click.group(cls=DYMGroup)  # Apply DYMGroup as the class for your main CLI group
def cli():
    """A simple CLI with did-you-mean suggestions."""
    pass

@cli.command()
def deploy():
    """Deploys the application."""
    click.echo("Deploying application...")

@cli.command()
def delete():
    """Deletes resources."""
    click.echo("Deleting resources...")

@cli.command()
def devops():
    """Runs devops tasks."""
    click.echo("Running devops tasks...")

if __name__ == '__main__':
    # Example usage (run from terminal, e.g., `python your_cli.py deplo`) will suggest `deploy`
    cli()

view raw JSON →