Metadata-Version: 1.0
Name: PyNameMatcher
Version: 0.1.2
Summary: Simple library for matching first names with possible variations
Home-page: https://github.com/constituentvoice/PyNameMatcher
Author: Constituent Voice LLC
Author-email: chris.brown@constituentvoice.com
License: Apache
Description: PyNameMatcher
        =============
        Help with matching names to nick-names and vice-versa. Based on data by https://github.com/carltonnorthern/nickname-and-diminutive-names-lookup
        
        INSTALL
        -------
        
        .. code-block::
        
            $ pip install PyNameMatcher
        
        
        USAGE
        -----
        .. code-block::
        
            from pynamematcher import PyNameMatcher
        
            matcher = PyNameMatcher(data_file=path_to_datafile)
            possible_names = matcher.match('Bob')
        
        
        
        DOCUMENTATION
        -------------
        
        `__init__()` Options
        
        :data_file:     Path to a CSV formatted data file of names. Defaults to an internal data file.
        
        :use_metaphone: Match names using the metaphone library to catch misspellings.
        
        `match()` Options
        
        :name:  First argument. The name to match
        
        :use_metaphone: used internally when `self.use_metaphone` is `True`
        
        :remove_match:  Remove the input name (default `True`). Used internally to keep
                        names when searching metaphone symbols.
        
        AUTHOR
        ------
        Chris Brown - chris.brown@constituentvoice.com
        
        LICENSE
        -------
        Licensed under Apache License 2.0. Copyright 2019 Constituent Voice LLC.
        
        See LICENSE for complete terms.
        
        
        
        
Platform: UNKNOWN
