thefuzz Documentation

To use thefuzz, ensure you meet the following requirements:

• Python 3.8 or higher
• rapidfuzz

You can install thefuzz using pip from PyPI.

pip install thefuzz

You can install thefuzz directly from the GitHub repository using pip or by cloning the repository manually.

# Using pip via GitHub
pip install git+git://github.com/seatgeek/thefuzz.git@0.19.0#egg=thefuzz

# Adding to requirements.txt
git+ssh://git@github.com/seatgeek/thefuzz.git@0.19.0#egg=thefuzz

# Manually via GIT
git clone git://github.com/seatgeek/thefuzz.git thefuzz
cd thefuzz
python setup.py install

The thefuzz.process module allows you to find the best matches for a string within a list of choices.

• process.extract(query, choices, limit=None): Returns a list of the top limit matches, where each match is a tuple of (match, score).
• process.extractOne(query, choices, scorer=None): Returns the single best match as a tuple of (match, score). You can specify a custom scorer from the fuzz module.

The thefuzz.fuzz module provides several methods to calculate the similarity between two strings using different algorithms based on Levenshtein Distance.

• fuzz.ratio: Simple ratio comparison.
• fuzz.partial_ratio: Partial ratio comparison.
• fuzz.token_sort_ratio: Compares strings after sorting tokens alphabetically.
• fuzz.token_set_ratio: Compares strings after sorting tokens and removing duplicates.
• fuzz.partial_token_sort_ratio: A combination of partial ratio and token sort ratio.