Jaro-Winkler Distance

3.0.0 · active · verified Wed Apr 15

pyjarowinkler is a Python library that calculates the Jaro-Winkler Distance, a measure of similarity between two strings. It's useful for tasks like spell-checking, record linkage, and data deduplication. The current version is 3.0.0, and it has a reasonably active release cadence.

Warnings

breaking The primary function `get_jaro_distance` was renamed to `jaro_winkler_distance`.
Fix: Update calls from `get_jaro_distance(s1, s2)` to `jaro_winkler_distance(s1, s2)`.
breaking The minimum required Python version was updated from 3.6 to 3.10.
Fix: Ensure your environment is running Python 3.10 or newer. For older Python versions, use `pyjarowinkler<3.0.0` (e.g., `pip install 'pyjarowinkler<3.0.0'`).
gotcha The package name is `pyjarowinkler`, but the main module to import from is `jarowinkler`.
Fix: Always use `from jarowinkler import ...` for imports, not `from pyjarowinkler import ...`.

Install

pip install pyjarowinkler Install stable version

Imports

jaro_winkler_distance
wrong:
```
from pyjarowinkler import jaro_winkler_distance
```
correct:
```
from jarowinkler import jaro_winkler_distance
```
The package is `pyjarowinkler`, but the main function is imported from the `jarowinkler` module. Also, the function was previously named `get_jaro_distance` in versions prior to 2.0.0.

Quickstart

This example demonstrates how to import and use the `jaro_winkler_distance` function to calculate the similarity between two strings. The score ranges from 0 (no similarity) to 1 (exact match).

from jarowinkler import jaro_winkler_distance

string1 = "MARTHA"
string2 = "MARHTA"

similarity_score = jaro_winkler_distance(string1, string2)
print(f"Jaro-Winkler Similarity between '{string1}' and '{string2}': {similarity_score}")

string3 = "DWAYNE"
string4 = "DUANE"
similarity_score_2 = jaro_winkler_distance(string3, string4)
print(f"Jaro-Winkler Similarity between '{string3}' and '{string4}': {similarity_score_2}")

view raw JSON →