This commit is contained in:
Iliyan Angelov
2025-09-14 23:24:25 +03:00
commit c67067a2a4
71311 changed files with 6800714 additions and 0 deletions

View File

@@ -0,0 +1,19 @@
Copyright (c) 2016 Timo Furrer
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

View File

@@ -0,0 +1,153 @@
Metadata-Version: 2.1
Name: click-didyoumean
Version: 0.3.1
Summary: Enables git-like *did-you-mean* feature in click
Home-page: https://github.com/click-contrib/click-didyoumean
License: MIT
Author: Timo Furrer
Author-email: timo.furrer@roche.com
Requires-Python: >=3.6.2
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: click (>=7)
Project-URL: Repository, https://github.com/click-contrib/click-didyoumean
Description-Content-Type: text/x-rst
click-didyoumean
================
|pypi| |build| |license|
Enable git-like *did-you-mean* feature in click.
It's as simple as this:
.. code:: python
import click
from click_didyoumean import DYMGroup
@click.group(cls=DYMGroup)
def cli():
...
|demo|
Usage
-----
Install this extension with pip:
.. code::
pip install click-didyoumean
Use specific *did-you-mean* `group` class for your cli:
.. code:: python
import click
from click_didyoumean import DYMGroup
@click.group(cls=DYMGroup)
def cli():
pass
@cli.command()
def foo():
pass
@cli.command()
def bar():
pass
@cli.command()
def barrr():
pass
if __name__ == "__main__":
cli()
Or you it in a `CommandCollection`:
.. code:: python
import click
from click_didyoumean import DYMCommandCollection
@click.group()
def cli1():
pass
@cli1.command()
def foo():
pass
@cli1.command()
def bar():
pass
@click.group()
def cli2():
pass
@cli2.command()
def barrr():
pass
cli = DYMCommandCollection(sources=[cli1, cli2])
if __name__ == "__main__":
cli()
Change configuration
--------------------
There are two configuration for the ``DYMGroup`` and ``DYMCommandCollection``:
+-----------------+-------+---------+---------------------------------------------------------------------------+
| Parameter | Type | Default | Description |
+=================+=======+=========+===========================================================================+
| max_suggestions | int | 3 | Maximal number of *did-you-mean* suggestions |
+-----------------+-------+---------+---------------------------------------------------------------------------+
| cutoff | float | 0.5 | Possibilities that dont score at least that similar to word are ignored. |
+-----------------+-------+---------+---------------------------------------------------------------------------+
Examples
~~~~~~~~
.. code:: python
@cli.group(cls=DYMGroup, max_suggestions=2, cutoff=0.7)
def cli():
pass
... or ...
cli = DYMCommandCollection(sources=[cli1, cli2], max_suggestions=2, cutoff=0.7)
.. |pypi| image:: https://img.shields.io/pypi/v/click-didyoumean.svg?style=flat&label=version
:target: https://pypi.python.org/pypi/click-didyoumean
:alt: Latest version released on PyPi
.. |build| image:: https://img.shields.io/travis/click-contrib/click-didyoumean/master.svg?style=flat
:target: http://travis-ci.org/click-contrib/click-didyoumean
:alt: Build status of the master branch
.. |demo| image:: https://raw.githubusercontent.com/click-contrib/click-didyoumean/master/examples/asciicast.gif
:alt: Demo
.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
:target: https://raw.githubusercontent.com/click-contrib/click-didyoumean/master/LICENSE
:alt: Package license

View File

@@ -0,0 +1,7 @@
click_didyoumean-0.3.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
click_didyoumean-0.3.1.dist-info/LICENSE,sha256=78dPJV3W_UKJNjsb_nHNDtcLKSbIJY1hUiBOaokEHAo,1056
click_didyoumean-0.3.1.dist-info/METADATA,sha256=GYONTKiVryMonBm2dZBpQGjVnQP_sesQFjfqLbf9AnU,3943
click_didyoumean-0.3.1.dist-info/RECORD,,
click_didyoumean-0.3.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
click_didyoumean/__init__.py,sha256=ZdVAFTqOmOQOcKAn8ew4Knr8tYXSDwQyEzc7az-gd08,2054
click_didyoumean/__pycache__/__init__.cpython-312.pyc,,

View File

@@ -0,0 +1,4 @@
Wheel-Version: 1.0
Generator: poetry-core 1.9.0
Root-Is-Purelib: true
Tag: py3-none-any