Metadata-Version: 2.1
Name: fastlevenshtein
Version: 0.1.8
Classifier: License :: OSI Approved :: GNU General Public License (GPL) 
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Rust
Classifier: Operating System :: POSIX :: Linux
Summary: A Rust-based levenshtein distance implementation.
Home-Page: https://github.com/thibaultbl/fastlevenshtein
Author: ThibaultB
Description-Content-Type: text/x-rst; charset=UTF-8
Project-URL: Source Code, https://github.com/thibaultbl/fastlevenshtein

.. contents ::

Introduction
------------
Rust implementation of levenshtein distance (https://en.wikipedia.org/wiki/Levenshtein_distance).

Installation
------------

::

   pip install fastlevenshtein


Usage
------------

First param is either a list or a str.

It will be compared to the second param that is a str.

The third param is the maximum value of levensthein. 
For example, if the third param is 3, if the levensthein value reach at least 3, the function with exit and return 3 as value.
This third param is used to increase computation time when you are only interested in string that are close to each other.
If you do not want to use early exit, you can just use a really high value for this param

::

   from fastlevenshtein import levenshtein
   levenshtein("string1", "string2", 999) # 999 so no early exit
   >>> 1

   from fastlevenshtein import levenshtein_list
   levenshtein_list(["string1", "string2"], "string3", 999)
   >>> [1, 1]

   from fastlevenshtein import levenshtein_list
   levenshtein_list(["aaaaaaaa", "bbbbbbbb"], "ccccccc", 3) # early exit at 3 maximum value for levensthein distance
   >>> [3, 3]


License
-------

fastlevenshtein is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.

See the file COPYING for the full text of GNU General Public License version 2.

