{ "info": { "author": "Timo Furrer", "author_email": "tuxtimo@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: BSD License", "Programming Language :: Python", "Programming Language :: Python :: 3" ], "description": "click-didyoumean\n================\n|pypi| |build| |license|\n\nEnable git-like *did-you-mean* feature in click.\n\nIt's as simple as this:\n\n.. code:: python\n\n import click\n from click_didyoumean import DYMGroup\n\n @click.group(cls=DYMGroup)\n def cli():\n ...\n\n|demo|\n\nUsage\n-----\n\nInstall this extension with pip:\n\n.. code::\n\n pip install click-didyoumean\n\n\nUse specific *did-you-mean* `group` class for your cli:\n\n\n.. code:: python\n\n import click\n from click_didyoumean import DYMGroup\n\n @click.group(cls=DYMGroup)\n def cli():\n pass\n\n @cli.command()\n def foo():\n pass\n\n @cli.command()\n def bar():\n pass\n\n @cli.command()\n def barrr():\n pass\n\n if __name__ == \"__main__\":\n cli()\n\n\nOr you it in a `CommandCollection`:\n\n.. code:: python\n\n import click\n from click_didyoumean import DYMCommandCollection\n\n @click.group()\n def cli1():\n pass\n\n @cli1.command()\n def foo():\n pass\n\n @cli1.command()\n def bar():\n pass\n\n @click.group()\n def cli2():\n pass\n\n @cli2.command()\n def barrr():\n pass\n\n cli = DYMCommandCollection(sources=[cli1, cli2])\n\n if __name__ == \"__main__\":\n cli()\n\n\nChange configuration\n--------------------\n\nThere are two configuration for the ``DYMGroup`` and ``DYMCommandCollection``:\n\n+-----------------+-------+---------+---------------------------------------------------------------------------+\n| Parameter | Type | Default | Description |\n+=================+=======+=========+===========================================================================+\n| max_suggestions | int | 3 | Maximal number of *did-you-mean* suggestions |\n+-----------------+-------+---------+---------------------------------------------------------------------------+\n| cutoff | float | 0.5 | Possibilities that don\u2019t score at least that similar to word are ignored. |\n+-----------------+-------+---------+---------------------------------------------------------------------------+\n\nExamples\n~~~~~~~~\n\n.. code:: python\n\n @cli.group(cls=DYMGroup, max_suggestions=2, cutoff=0.7)\n def cli():\n pass\n\n ... or ...\n\n cli = DYMCommandCollection(sources=[cli1, cli2], max_suggestions=2, cutoff=0.7)\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/click-didyoumean.svg?style=flat&label=version\n :target: https://pypi.python.org/pypi/click-didyoumean\n :alt: Latest version released on PyPi\n\n.. |build| image:: https://img.shields.io/travis/timofurrer/click-didyoumean/master.svg?style=flat\n :target: http://travis-ci.org/timofurrer/click-didyoumean\n :alt: Build status of the master branch\n\n.. |demo| image:: https://asciinema.org/a/duyr2j5d7w7fhpe7xf71rafgr.png\n :target: https://asciinema.org/a/duyr2j5d7w7fhpe7xf71rafgr\n :alt: Demo\n\n.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat\n :target: https://raw.githubusercontent.com/timofurrer/click-didyoumean/master/LICENSE\n :alt: Package license\n", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/timofurrer/click-didyoumean", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "click-didyoumean", "package_url": "https://pypi.org/project/click-didyoumean/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/click-didyoumean/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/timofurrer/click-didyoumean" }, "release_url": "https://pypi.org/project/click-didyoumean/0.0.3/", "requires_dist": null, "requires_python": null, "summary": "Enable git-like did-you-mean feature in click.", "version": "0.0.3" }, "last_serial": 2003793, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "b43972485b4338029df1d7d055e01112", "sha256": "741fc03df7e70259d51947a32699c91427879dd864d709e8e586fc3681c94398" }, "downloads": -1, "filename": "click-didyoumean-0.0.1.tar.gz", "has_sig": false, "md5_digest": "b43972485b4338029df1d7d055e01112", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2561, "upload_time": "2016-03-13T00:51:18", "url": "https://files.pythonhosted.org/packages/cd/1b/e990329a60aaea296afc77857c0504594645068a253ab9c739cf4bcbb41d/click-didyoumean-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "7c0f5bf8b90a866e7777052907f93914", "sha256": "9960e0b2c762a268d2a459257bf226bbf543acf9b4f8b91d2638dc7cfc689c09" }, "downloads": -1, "filename": "click-didyoumean-0.0.2.tar.gz", "has_sig": false, "md5_digest": "7c0f5bf8b90a866e7777052907f93914", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2689, "upload_time": "2016-03-13T01:00:42", "url": "https://files.pythonhosted.org/packages/b0/fd/463c4e3ac9bd7bb20c7203ea9d9b7eb978c9bb4f76631b62f70795020706/click-didyoumean-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "08ac34aa0355f58ffc43ee57f1969ffb", "sha256": "112229485c9704ff51362fe34b2d4f0b12fc71cc20f6d2b3afabed4b8bfa6aeb" }, "downloads": -1, "filename": "click-didyoumean-0.0.3.tar.gz", "has_sig": false, "md5_digest": "08ac34aa0355f58ffc43ee57f1969ffb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2562, "upload_time": "2016-03-13T01:13:45", "url": "https://files.pythonhosted.org/packages/9f/79/d265d783dd022541b744d002745d9e55d84c04a41930e35d8795934f6526/click-didyoumean-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "08ac34aa0355f58ffc43ee57f1969ffb", "sha256": "112229485c9704ff51362fe34b2d4f0b12fc71cc20f6d2b3afabed4b8bfa6aeb" }, "downloads": -1, "filename": "click-didyoumean-0.0.3.tar.gz", "has_sig": false, "md5_digest": "08ac34aa0355f58ffc43ee57f1969ffb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2562, "upload_time": "2016-03-13T01:13:45", "url": "https://files.pythonhosted.org/packages/9f/79/d265d783dd022541b744d002745d9e55d84c04a41930e35d8795934f6526/click-didyoumean-0.0.3.tar.gz" } ] }