diff --git a/.github/workflows/branchbuild.yml b/.github/workflows/branchbuild.yml index 710356aa..44b89a01 100644 --- a/.github/workflows/branchbuild.yml +++ b/.github/workflows/branchbuild.yml @@ -43,7 +43,7 @@ jobs: - name: Install rapidfuzz-cpp run: | - git clone https://github.com/maxbachmann/rapidfuzz-cpp.git + git clone https://github.com/rapidfuzz/rapidfuzz-cpp.git cd rapidfuzz-cpp git checkout v1.0.1 mkdir build && cd build diff --git a/README.md b/README.md index 6a4e8fe9..94217254 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@

-RapidFuzz +RapidFuzz

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

- - + Continuous Integration @@ -20,16 +20,16 @@ Python versions
- + Documentation - - + Code Coverage - - + GitHub license

@@ -47,9 +47,9 @@ RapidFuzz is a fast string matching library for Python and C++, which is using the string similarity calculations from [FuzzyWuzzy](https://github.com/seatgeek/fuzzywuzzy). However there are a couple of 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 GPL license when using FuzzyWuzzy 2) It provides many string_metrics like hamming or jaro_winkler, which are not included in FuzzyWuzzy -3) 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. For detailed benchmarks check the [documentation](https://maxbachmann.github.io/RapidFuzz) +3) 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. For detailed benchmarks check the [documentation](https://rapidfuzz.github.io/RapidFuzz) 4) Fixes multiple bugs in the `partial_ratio` implementation -5) It can be largely used as a drop in replacement for `fuzzywuzzy`. However there are a couple API differences described [here](https://github.com/maxbachmann/RapidFuzz/blob/main/api_differences.md) +5) It can be largely used as a drop in replacement for `fuzzywuzzy`. However there are a couple API differences described [here](https://github.com/rapidfuzz/RapidFuzz/blob/main/api_differences.md) ## Requirements @@ -88,13 +88,13 @@ conda install -c conda-forge rapidfuzz RapidFuzz can be installed directly from the source distribution by cloning the repository. This requires a C++17 capable compiler. ```bash -git clone --recursive https://github.com/maxbachmann/rapidfuzz.git +git clone --recursive https://github.com/rapidfuzz/rapidfuzz.git cd rapidfuzz pip install . ``` ## Usage -Some simple functions are shown below. A complete documentation of all functions can be found [here](https://maxbachmann.github.io/RapidFuzz/Usage/index.html).
+Some simple functions are shown below. A complete documentation of all functions can be found [here](https://rapidfuzz.github.io/RapidFuzz/Usage/index.html).
Note that from RapidFuzz 3.0.0, strings are not preprocessed(removing all non alphanumeric characters, trimming whitespaces, converting all characters to lower case) by default. Which means that when comparing two strings that have the same characters but different cases("this is a word", "THIS IS A WORD") their similarity score value might be different, so when comparing such strings you might see a difference in score value compared to previous versions. Some examples of string matching with preprocessing can be found [here](#weighted-ratio). ### Scorers @@ -193,12 +193,12 @@ Here are some examples on the usage of processors in RapidFuzz: ('Dallas Cowboys', 90.0, 3) ``` -The full documentation of processors can be found [here](https://maxbachmann.github.io/RapidFuzz/Usage/process.html) +The full documentation of processors can be found [here](https://rapidfuzz.github.io/RapidFuzz/Usage/process.html) ## Benchmark The following benchmark gives a quick performance comparison between RapidFuzz and FuzzyWuzzy. -More detailed benchmarks for the string metrics can be found in the [documentation](https://maxbachmann.github.io/RapidFuzz). For this simple comparison I generated a list of 10.000 strings with length 10, that is compared to a sample of 100 elements from this list: +More detailed benchmarks for the string metrics can be found in the [documentation](https://rapidfuzz.github.io/RapidFuzz). For this simple comparison I generated a list of 10.000 strings with length 10, that is compared to a sample of 100 elements from this list: ```python words = [ "".join(random.choice(string.ascii_letters + string.digits) for _ in range(10)) @@ -216,7 +216,7 @@ for sample in samples: ``` 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 -Benchmark Scorer +Benchmark Scorer The second benchmark compares the performance when the scorers are used in combination with cdist in the following way: @@ -225,7 +225,7 @@ cdist(samples, words, 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 `cdist` is a lot faster than directly using it. That's why they should be used whenever possible. -Benchmark cdist +Benchmark cdist ## Support the project diff --git a/docs/Contributing/index.rst b/docs/Contributing/index.rst index 8eae1239..216f95a1 100644 --- a/docs/Contributing/index.rst +++ b/docs/Contributing/index.rst @@ -11,13 +11,13 @@ Got a question or problem? ^^^^^^^^^^^^^^^^^^^^^^^^^^ For questions you can reach us using -`github discussions `__. +`github discussions `__. Found a bug? ^^^^^^^^^^^^ If you found a bug in the source code, you can help us by submitting an issue -to the `issue tracker `__ +to the `issue tracker `__ in our GitHub repository. Even better, you can submit a Pull Request with a fix. However, before doing so, please read the :ref:`submission-guidelines`. diff --git a/docs/Installation.rst b/docs/Installation.rst index c7eb4471..dafb7e17 100644 --- a/docs/Installation.rst +++ b/docs/Installation.rst @@ -45,6 +45,6 @@ repository. This requires a C++17 capable compiler. .. code-block:: sh - git clone --recursive https://github.com/maxbachmann/rapidfuzz.git + git clone --recursive https://github.com/rapidfuzz/rapidfuzz.git cd rapidfuzz pip install . diff --git a/docs/index.rst b/docs/index.rst index b3654174..b571e097 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,7 +25,7 @@ where compiling a C extension is not possible. Open source ----------- -Distributed under a :ref:`MIT License `, RapidFuzz is developed and maintained `publicly on GitHub `_. +Distributed under a :ref:`MIT License `, RapidFuzz is developed and maintained `publicly on GitHub `_. .. toctree:: @@ -42,6 +42,6 @@ Distributed under a :ref:`MIT License `, RapidFuzz is develope changelog_link License References - GitHub Repository + GitHub Repository .. |header-image| image:: img/RapidFuzz.svg diff --git a/setup.py b/setup.py index dc4a5cb3..0ae00061 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ def show_message(*lines): "name": "rapidfuzz", "version": "3.6.0", "extras_require": {"full": ["numpy"]}, - "url": "https://github.com/maxbachmann/RapidFuzz", + "url": "https://github.com/rapidfuzz/RapidFuzz", "author": "Max Bachmann", "author_email": "pypi@maxbachmann.de", "description": "rapid fuzzy string matching", diff --git a/src/rapidfuzz/fuzz_py.py b/src/rapidfuzz/fuzz_py.py index 6c577a9e..fcee6cee 100644 --- a/src/rapidfuzz/fuzz_py.py +++ b/src/rapidfuzz/fuzz_py.py @@ -449,7 +449,7 @@ def token_set_ratio( tokens_b = set(_split_sequence(s2)) # in FuzzyWuzzy this returns 0. For sake of compatibility return 0 here as well - # see https://github.com/maxbachmann/RapidFuzz/issues/110 + # see https://github.com/rapidfuzz/RapidFuzz/issues/110 if not tokens_a or not tokens_b: return 0 @@ -636,7 +636,7 @@ def partial_token_set_ratio( tokens_a = set(_split_sequence(s1)) tokens_b = set(_split_sequence(s2)) # in FuzzyWuzzy this returns 0. For sake of compatibility return 0 here as well - # see https://github.com/maxbachmann/RapidFuzz/issues/110 + # see https://github.com/rapidfuzz/RapidFuzz/issues/110 if not tokens_a or not tokens_b: return 0 @@ -771,7 +771,7 @@ def WRatio( s2 = processor(s2) # in FuzzyWuzzy this returns 0. For sake of compatibility return 0 here as well - # see https://github.com/maxbachmann/RapidFuzz/issues/110 + # see https://github.com/rapidfuzz/RapidFuzz/issues/110 if not s1 or not s2: return 0 @@ -845,7 +845,7 @@ def QRatio( s1 = processor(s1) s2 = processor(s2) # in FuzzyWuzzy this returns 0. For sake of compatibility return 0 here as well - # see https://github.com/maxbachmann/RapidFuzz/issues/110 + # see https://github.com/rapidfuzz/RapidFuzz/issues/110 if not s1 or not s2: return 0 diff --git a/tests/test_fuzz.py b/tests/test_fuzz.py index b838c577..23f800f0 100644 --- a/tests/test_fuzz.py +++ b/tests/test_fuzz.py @@ -225,7 +225,7 @@ def test_issue231(): def test_empty_string(): """ when both strings are empty this is either a perfect match or no match - See https://github.com/maxbachmann/RapidFuzz/issues/110 + See https://github.com/rapidfuzz/RapidFuzz/issues/110 """ # perfect match assert fuzz.ratio("", "") == 100