Rooba
/
RapidFuzz
mirror of https://github.com/maxbachmann/RapidFuzz.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Rapid fuzzy string matching in Python using various string metrics
49 Commits 8 Branches 130 Tags 13 MiB
C++ 39.4%
Python 38.4%
Cython 19.8%
CMake 1.6%
C 0.7%
Go to file
maxbachmann ab8e98bc2d
add missing files to tarball 		2020-04-04 06:51:45 +02:00
.github release 0.6.0 2020-04-04 06:15:37 +02:00
cpp release 0.6.0 2020-04-04 06:15:37 +02:00
python release 0.6.0 2020-04-04 06:15:37 +02:00
.gitattributes release 0.6.0 2020-04-04 06:15:37 +02:00
.gitignore reduce template usage to a minimum 2020-03-31 15:16:03 +02:00
Benchmarks.md fix svg url 2020-04-04 06:19:02 +02:00
CHANGELOG release 0.6.0 2020-04-04 06:15:37 +02:00
LICENSE initialise c++ version 2020-02-29 15:45:15 +01:00
MANIFEST.in add missing files to tarball 2020-04-04 06:51:45 +02:00
README.md release 0.6.0 2020-04-04 06:15:37 +02:00
VERSION add missing files to tarball 2020-04-04 06:51:45 +02:00
setup.py replace std::wstring_view with boost::wstring_view to add C++14 support 2020-04-03 14:38:34 +02:00

README.md

RapidFuzz

Rapid fuzzy string matching in Python and C++ using the Levenshtein Distance

Continous Integration PyPI package version Python versions GitHub license

Description • Installation • Usage • License

Description

RapidFuzz is a fast string matching library for Python and C++, which is using the string similarity calculations from FuzzyWuzzy. However there are two aspects that set RapidFuzz apart from FuzzyWuzzy:

  1. It is MIT licensed so it can be used whichever License you might want to choose for your project, while you're forced to adopt the GPLv2 license when using FuzzyWuzzy
  2. It is mostly written in C++ and on top of this comes with a lot of Algorithmic improvements to make string matching even faster, while still providing the same results. These changes result in a 2-100x Speedup in String Matching. More details on benchmark results can be found here

Installation

RapidFuzz can be installed using pip

$ pip install rapidfuzz

We currently have pre-built binaries (wheels) for RapidFuzz and its dependencies for MacOS (10.9 and later), Linux x86_64 and Windows.

For any other architecture/os RapidFuzz can be installed from the source distribution. To do so, a C++14 capable compiler must be installed before running the pip install rapidfuzz command. While Linux and MacOs usually come with a compiler it is required to install C++-Buildtools on Windows.

Usage

> from rapidfuzz import fuzz
> from rapidfuzz import process

Simple Ratio

> fuzz.ratio("this is a test", "this is a test!")
96.55171966552734

Partial Ratio

> fuzz.partial_ratio("this is a test", "this is a test!")
100.0

Token Sort Ratio

> fuzz.ratio("fuzzy wuzzy was a bear", "wuzzy fuzzy was a bear")
90.90908813476562
> fuzz.token_sort_ratio("fuzzy wuzzy was a bear", "wuzzy fuzzy was a bear")
100.0

Token Set Ratio

> fuzz.token_sort_ratio("fuzzy was a bear", "fuzzy fuzzy was a bear")
83.8709716796875
> fuzz.token_set_ratio("fuzzy was a bear", "fuzzy fuzzy was a bear")
100.0

Process

> choices = ["Atlanta Falcons", "New York Jets", "New York Giants", "Dallas Cowboys"]
> process.extract("new york jets", choices, limit=2)
[('new york jets', 100), ('new york giants', 78.57142639160156)]
> process.extractOne("cowboys", choices)
("dallas cowboys", 90)

License

RapidFuzz is licensed under the MIT license since we believe that everyone should be able to use it without being forced to adopt our license. Thats why the library is based on an older version of fuzzywuzzy that was MIT licensed as well. A Fork of this old version of fuzzywuzzy can be found here.