Metadata-Version: 2.1
Name: cmd2-abbrev
Version: 1.1.0
Summary: Plugin to add command abbreviation support to cmd2
Home-page: https://github.com/python-cmd2/cmd2-abbrev
Author: Kotfu
Author-email: kotfu@kotfu.net
License: MIT
Description: # cmd2-abbrev
        
        ## Description
        
        Plugin for cmd2 to support previously deprecated abbreviation behavior.
        
        Adds a setting `abbrev` which allows users to control whether commands
        can be abbreviated. If an application has a `speak` command:
        ```
        (Cmd) speak hello
        hello
        ```
        then any unique prefix of any command will run the command:
        ```
        (Cmd) set abbrev True
        abbrev - was: False
        now: True
        (Cmd) sp hello
        hello
        ```
        
        Non-unique abbreviations generate a syntax error:
        ```
        (Cmd) s hello
        *** Unknown syntax: s hello
        (Cmd) help
        
        Documented commands (type help <topic>):
        ========================================
        alias  help     load  pyscript  set    shortcuts  unalias
        edit   history  py    quit      shell  speak
        ```
        
        ## Installation
        
        System requirements: works anywhere `cmd2` works (Windows, Linux, MacOS).
        Requires `cmd2` version 0.9.12 or higher.
        
        Install using pip:
        ```
        $ pip install cmd2-abbrev
        ```
        
        Add to your `cmd2` application by mixing in the `AbbrevMixin` class:
        ```python
        import cmd2
        import cmd2_abbrev
        
        class AbbrevExample(cmd2_abbrev.AbbrevMixin, cmd2.Cmd):
            """A cmd2 program to demonstrate the use of the cmd2_abbrev plugin"""
            def __init__(self, *args, **kwargs):
                super().__init__(*args, **kwargs)
        ```
        
        You must mix in `AbbrevMixin` before `cmd2.Cmd` or it won't work properly.
        
Keywords: cmd2 plugin abbrev
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: dev
