Metadata-Version: 1.2
Name: jellyfish
Version: 0.7.1
Summary: a library for doing approximate and phonetic matching of strings.
Home-page: http://github.com/jamesturk/jellyfish
License: UNKNOWN
Description: =========
        jellyfish
        =========
        
        .. image:: https://travis-ci.org/jamesturk/jellyfish.svg?branch=master
            :target: https://travis-ci.org/jamesturk/jellyfish
        
        .. image:: https://coveralls.io/repos/jamesturk/jellyfish/badge.png?branch=master
            :target: https://coveralls.io/r/jamesturk/jellyfish
        
        .. image:: https://img.shields.io/pypi/v/jellyfish.svg
            :target: https://pypi.python.org/pypi/jellyfish
        
        .. image:: https://readthedocs.org/projects/jellyfish/badge/?version=latest
            :target: https://readthedocs.org/projects/jellyfish/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://ci.appveyor.com/api/projects/status/9xeyl1f5sd5pl40h?svg=true
            :target: https://ci.appveyor.com/project/jamesturk/jellyfish/
        
        Jellyfish is a python library for doing approximate and phonetic matching of strings.
        
        Written by James Turk <dev@jamesturk.net> and Michael Stephens.
        
        See https://github.com/jamesturk/jellyfish/graphs/contributors for contributors.
        
        See http://jellyfish.readthedocs.io for documentation.
        
        Source is available at http://github.com/jamesturk/jellyfish.
        
        **Jellyfish >= 0.7 only supports Python 3, if you need Python 2 please use 0.6.x.**
        
        Included Algorithms
        ===================
        
        String comparison:
        
        * Levenshtein Distance
        * Damerau-Levenshtein Distance
        * Jaro Distance
        * Jaro-Winkler Distance
        * Match Rating Approach Comparison
        * Hamming Distance
        
        Phonetic encoding:
        
        * American Soundex
        * Metaphone
        * NYSIIS (New York State Identification and Intelligence System)
        * Match Rating Codex
        
        Example Usage
        =============
        
        >>> import jellyfish
        >>> jellyfish.levenshtein_distance(u'jellyfish', u'smellyfish')
        2
        >>> jellyfish.jaro_distance(u'jellyfish', u'smellyfish')
        0.89629629629629637
        >>> jellyfish.damerau_levenshtein_distance(u'jellyfish', u'jellyfihs')
        1
        
        >>> jellyfish.metaphone(u'Jellyfish')
        'JLFX'
        >>> jellyfish.soundex(u'Jellyfish')
        'J412'
        >>> jellyfish.nysiis(u'Jellyfish')
        'JALYF'
        >>> jellyfish.match_rating_codex(u'Jellyfish')
        'JLLFSH'
        
        Running Tests
        =============
        
        If you are interested in contributing to Jellyfish, you may want to
        run tests locally. Jellyfish uses tox_ to run tests, which you can
        setup and run as follows::
        
          pip install tox
          # cd jellyfish/
          tox
        
        .. _tox: https://tox.readthedocs.io/en/latest/
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >3.4
