Metadata-Version: 1.1
Name: howabout
Version: 1.0
Summary: A library to suggest similar strings.
Home-page: https://github.com/clibc/howabout
Author: Charlie Liban
Author-email: charlie@clib.ca
License: MIT License
Download-URL: https://github.com/clibc/howabout/zipball/master
Description: How about ___
        =============
        
        Howabout is a Python library to suggest similar strings. Use it in a command-line project or anywhere where simple misspellings occur.
        
        .. code:: python
        
           from howabout import best_match
        
           choices = ['sat', 'sot']
        
           # returns 'sat', since 
           #   'sat' -> 'sate'
           #   'sot' -> 'sat' -> 'sate'
           best_match('sate', choices) 
        
        Examples can be found under ``examples/``.
        
        Argparse
        --------
        
        Python's ``argparse`` library is not supported out of the box as it cannot be extended or patched.
        
        Installation
        ------------
        
        Install with pip:
        
        .. code:: sh
        
           $ pip install howabout
        
        Testing
        -------
        
        If you want to run the tests, install the requirements in ``requirements.txt``:
        
        .. code:: sh
        
           $ virtualenv --no-site-packages .python && source .python/bin/activate
           $ pip install -r requirements.txt
        
        
        
Keywords: cli
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: MIT License
