Metadata-Version: 2.4
Name: ukkonen
Version: 1.0.1
Summary: Implementation of bounded Levenshtein distance (Ukkonen)
Home-page: https://www.github.com/asottile/ukkonen
Author: Anthony Sottile
Author-email: asottile@umich.edu
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
License-File: licenses/LICENSE
License-File: LICENSE
Requires-Dist: cffi>=1
Dynamic: license-file

[![Build Status](https://dev.azure.com/asottile/asottile/_apis/build/status/asottile.ukkonen?branchName=master)](https://dev.azure.com/asottile/asottile/_build/latest?definitionId=71&branchName=master)
[![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/asottile/asottile/71/master.svg)](https://dev.azure.com/asottile/asottile/_build/latest?definitionId=71&branchName=master)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/asottile/ukkonen/master.svg)](https://results.pre-commit.ci/latest/github/asottile/ukkonen/master)

ukkonen
=======

Implementation of bounded Levenshtein distance (Ukkonen)

### port

this is a port of [ukkonen] from javascript to c++ / python via cffi.

[ukkonen]: https://github.com/sunesimonsen/ukkonen

### installation

```bash
pip install ukkonen
```

- wheels should be available on pypi in most cases

### api

#### `distance(s1: str, s2: str, k: int) -> int`

compute the edit distance, bounded by `k`

```pycon
>>> import ukkonen
>>> ukkonen.distance('hello', 'world', 5)
4
>>> ukkonen.distance('hello', 'world', 2)
2
```
