RapidFuzz

rapid fuzzy string matching

These details have not been verified by PyPI

Project links

Homepage

Project description

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

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:

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 GPL license when using FuzzyWuzzy
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. More details on these performance improvements in form of benchmarks can be found here

Requirements

Python 3.5 or later
On Windows the Visual C++ 2019 redistributable is required

Installation

There are several ways to install RapidFuzz, the recommended methods are to either use pip(the Python package manager) or conda (an open-source, cross-platform, package manager)

with pip

RapidFuzz can be installed with pip the following way:

pip install rapidfuzz

There are pre-built binaries (wheels) of RapidFuzz for MacOS (10.9 and later), Linux x86_64 and Windows. Wheels for armv6l (Raspberry Pi Zero) and armv7l (Raspberry Pi) are available on piwheels.

:heavy_multiplication_x: failure "ImportError: DLL load failed"

If you run into this error on Windows the reason is most likely, that the Visual C++ 2019 redistributable is not installed, which is required to find C++ Libraries (The C++ 2019 version includes the 2015, 2017 and 2019 version).

with conda

RapidFuzz can be installed with conda:

conda install -c conda-forge rapidfuzz

from git

RapidFuzz can be installed directly from the source distribution by cloning the repository. This requires a C++14 capable compiler.

git clone https://github.com/maxbachmann/rapidfuzz.git
cd rapidfuzz
pip install .

Usage

Some simple functions are shown below. A complete documentation of all functions can be found here.

Scorers

Scorers in RapidFuzz can be found in the modules fuzz and string_metric.

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

The process module makes it compare strings to lists of strings. This is generally more performant than using the scorers directly from Python. Here are some examples on the usage of processors in RapidFuzz:

> from rapidfuzz import process, fuzz
> choices = ["Atlanta Falcons", "New York Jets", "New York Giants", "Dallas Cowboys"]
> process.extract("new york jets", choices, scorer=fuzz.WRatio, limit=2)
[('New York Jets', 100, 1), ('New York Giants', 78.57142639160156, 2)]
> process.extractOne("cowboys", choices, scorer=fuzz.WRatio)
("Dallas Cowboys", 90, 3)

The full documentation of processors can be found here

Benchmark

The following benchmark gives a quick performance comparision between RapidFuzz and FuzzyWuzzy. More detailed benchmarks for the string metrics can be found in the documentation. For this simple comparision I generated a list of 10.000 strings with length 10, that is compared to a sample of 100 elements from this list:

words = [
  ''.join(random.choice(string.ascii_letters + string.digits) for _ in range(10))
  for _ in range(10_000)
]
samples = words[::len(words) // 100]

The first benchmark compares the performance of the scorers in FuzzyWuzzy and RapidFuzz when they are used directly from Python in the following way:

for sample in samples:
  for word in words:
    scorer(sample, word)

The following graph shows how many elements are processed per second with each of the scorers. There are big performance differences between the different scorers. However each of the scorers is faster in RapidFuzz

The second benchmark compares the performance when the scorers are used in combination with extractOne in the following way:

for sample in samples:
  extractOne(sample, word, scorer=scorer)

The following graph shows how many elements are processed per second with each of the scorers. In RapidFuzz the usage of scorers through processors like extractOne is a lot faster than directly using it. Thats why they should be used whenever possible.

License

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

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

3.10.1

Oct 24, 2024

3.10.0

Sep 23, 2024

3.9.7

Sep 2, 2024

3.9.6

Aug 6, 2024

3.9.5

Jul 29, 2024

3.9.4

Jul 2, 2024

3.9.3

May 31, 2024

3.9.2

May 29, 2024

3.9.1

May 19, 2024

3.9.0

May 2, 2024

3.8.1

Apr 7, 2024

3.8.0

Apr 6, 2024

3.7.0

Mar 24, 2024

3.6.2

Mar 6, 2024

3.6.1

Dec 29, 2023

3.6.0

Dec 26, 2023

3.5.2

Nov 2, 2023

3.5.1

Nov 1, 2023

3.4.0

Oct 9, 2023

3.3.1

Sep 25, 2023

3.3.0

Sep 13, 2023

3.2.0

Aug 2, 2023

3.1.2

Jul 20, 2023

3.1.1

Jun 6, 2023

3.1.0

Jun 2, 2023

3.0.0

Apr 17, 2023

2.15.2

Oct 7, 2023

2.15.1

Apr 11, 2023

2.15.0

Apr 1, 2023

2.14.0

Mar 31, 2023

2.13.7

Dec 20, 2022

2.13.6

Dec 11, 2022

2.13.5

Dec 11, 2022

2.13.4

Dec 8, 2022

2.13.3

Dec 3, 2022

2.13.2

Nov 6, 2022

2.13.1

Nov 3, 2022

2.13.0

Oct 30, 2022

2.12.0

Oct 24, 2022

2.11.1

Oct 4, 2022

2.11.0

Oct 2, 2022

2.10.3

Sep 30, 2022

2.10.2

Sep 27, 2022

2.10.1

Sep 25, 2022

2.10.0

Sep 18, 2022

2.9.0

Sep 16, 2022

2.8.0

Sep 12, 2022

2.7.0

Sep 11, 2022

2.6.1

Sep 4, 2022

2.6.0

Aug 20, 2022

2.5.0

Aug 14, 2022

2.4.3

Aug 8, 2022

2.4.2

Jul 30, 2022

2.4.1

Jul 30, 2022

2.3.0

Jul 23, 2022

2.2.0

Jul 19, 2022

2.1.4

Jul 17, 2022

2.1.3

Jul 9, 2022

2.1.2

Jul 4, 2022

2.1.1

Jul 1, 2022

2.1.0

Jun 29, 2022

2.0.15

Jun 24, 2022

2.0.14

Jun 23, 2022

2.0.13

Jun 22, 2022

2.0.12

Jun 22, 2022

2.0.11

Apr 23, 2022

2.0.10

Apr 18, 2022

2.0.9

Apr 15, 2022

2.0.8

Apr 8, 2022

2.0.7

Mar 13, 2022

2.0.6

Mar 6, 2022

2.0.5

Feb 25, 2022

2.0.4

Feb 24, 2022

2.0.3

Feb 19, 2022

2.0.2

Feb 12, 2022

2.0.1

Feb 11, 2022

2.0.0

Feb 9, 2022

1.9.1

Dec 13, 2021

1.9.0

Dec 11, 2021

1.8.3

Nov 19, 2021

1.8.2

Oct 27, 2021

1.8.1

Oct 22, 2021

1.8.0

Oct 20, 2021

1.7.1

Oct 2, 2021

1.7.0

Sep 27, 2021

1.6.2

Sep 15, 2021

1.6.1

Sep 11, 2021

1.6.0

Sep 10, 2021

1.5.1

Sep 1, 2021

1.5.0

Aug 21, 2021

1.4.1

Mar 29, 2021

This version

1.4.0

Mar 29, 2021

1.3.3

Mar 20, 2021

1.3.2

Mar 20, 2021

1.3.1

Mar 20, 2021

1.3.0

Mar 16, 2021

1.2.1

Mar 8, 2021

1.2.0

Mar 7, 2021

1.1.2

Mar 3, 2021

1.1.1

Feb 23, 2021

1.1.0

Feb 21, 2021

1.0.2

Feb 19, 2021

1.0.1

Feb 17, 2021

1.0.0

Feb 12, 2021

0.14.2

Dec 31, 2020

0.14.1

Dec 14, 2020

0.14.0

Dec 9, 2020

0.13.4

Nov 30, 2020

0.13.3

Nov 21, 2020

0.13.2

Nov 21, 2020

0.13.1

Nov 17, 2020

0.13.0

Nov 16, 2020

0.12.5

Oct 26, 2020

0.12.4

Oct 22, 2020

0.12.3

Oct 9, 2020

0.12.2

Oct 1, 2020

0.12.1

Sep 30, 2020

0.12.0

Sep 30, 2020

0.11.3

Sep 22, 2020

0.11.2

Sep 12, 2020

0.11.1

Sep 1, 2020

0.11.0

Aug 22, 2020

0.10.0

Aug 14, 2020

0.9.1

May 24, 2020

0.9.0

May 22, 2020

0.8.2

May 21, 2020

0.8.1

May 20, 2020

0.8.0

May 16, 2020

0.7.12

May 7, 2020

0.7.11

May 7, 2020

0.7.10

Apr 29, 2020

0.7.9

Apr 28, 2020

0.7.8

Apr 24, 2020

0.7.7

Apr 22, 2020

0.7.6

Apr 16, 2020

0.7.5

Apr 15, 2020

0.7.4

Apr 15, 2020

0.7.3

Apr 9, 2020

0.7.2

Apr 9, 2020

0.7.1

Apr 8, 2020

0.7.0

Apr 8, 2020

0.6.8

Apr 7, 2020

0.6.7

Apr 5, 2020

0.6.6

Apr 5, 2020

0.6.5

Apr 5, 2020

0.6.4

Apr 5, 2020

0.6.3

Apr 4, 2020

0.6.2

Apr 4, 2020

0.6.1

Apr 4, 2020

0.6.0

Apr 4, 2020

0.5.3

Apr 3, 2020

0.5.2

Apr 3, 2020

0.5.1

Apr 1, 2020

0.5.0

Apr 1, 2020

0.4.0

Mar 29, 2020

0.3.0

Mar 26, 2020

0.2.2

Mar 23, 2020

0.2.1

Mar 22, 2020

0.2.0

Mar 22, 2020

0.1.1

Mar 20, 2020

0.1.0

Mar 20, 2020

0.0.8

Mar 19, 2020

0.0.7

Mar 18, 2020

0.0.6

Mar 18, 2020

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rapidfuzz-1.4.0.tar.gz (298.9 kB view details)

Uploaded Mar 29, 2021 Source

Built Distributions

rapidfuzz-1.4.0-pp37-pypy37_pp73-win32.whl (324.8 kB view details)

Uploaded Mar 29, 2021 PyPy Windows x86

rapidfuzz-1.4.0-pp37-pypy37_pp73-manylinux2010_x86_64.whl (719.1 kB view details)

Uploaded Mar 29, 2021 PyPy manylinux: glibc 2.12+ x86-64

rapidfuzz-1.4.0-pp37-pypy37_pp73-manylinux1_x86_64.whl (719.1 kB view details)

Uploaded Mar 29, 2021 PyPy

rapidfuzz-1.4.0-pp37-pypy37_pp73-macosx_10_9_x86_64.whl (515.4 kB view details)

Uploaded Mar 29, 2021 PyPy macOS 10.9+ x86-64

rapidfuzz-1.4.0-pp36-pypy36_pp73-win32.whl (324.8 kB view details)

Uploaded Mar 29, 2021 PyPy Windows x86

rapidfuzz-1.4.0-pp36-pypy36_pp73-manylinux2010_x86_64.whl (719.1 kB view details)

Uploaded Mar 29, 2021 PyPy manylinux: glibc 2.12+ x86-64

rapidfuzz-1.4.0-pp36-pypy36_pp73-manylinux1_x86_64.whl (719.1 kB view details)

Uploaded Mar 29, 2021 PyPy

rapidfuzz-1.4.0-pp36-pypy36_pp73-macosx_10_9_x86_64.whl (515.4 kB view details)

Uploaded Mar 29, 2021 PyPy macOS 10.9+ x86-64

rapidfuzz-1.4.0-cp39-cp39-win_amd64.whl (429.9 kB view details)

Uploaded Mar 29, 2021 CPython 3.9 Windows x86-64

rapidfuzz-1.4.0-cp39-cp39-win32.whl (335.8 kB view details)

Uploaded Mar 29, 2021 CPython 3.9 Windows x86

rapidfuzz-1.4.0-cp39-cp39-manylinux2014_s390x.whl (711.9 kB view details)