diff --git a/README.md b/README.md new file mode 100644 index 0000000..e7e1aaf --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ + +## This project has been renamed and moved to https://github.com/seatgeek/thefuzz + + +**[TheFuzz](https://github.com/seatgeek/thefuzz)** version 0.19.0 correlates with this project's 0.18.0 version with `thefuzz` replacing all instances of this project's name. + +PRs and issues here will need to be resubmitted to **[TheFuzz](https://github.com/seatgeek/thefuzz)** \ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index 7a8b946..0000000 --- a/README.rst +++ /dev/null @@ -1,141 +0,0 @@ -.. image:: https://travis-ci.org/seatgeek/fuzzywuzzy.svg?branch=master - :target: https://travis-ci.org/seatgeek/fuzzywuzzy - -FuzzyWuzzy -========== - -Fuzzy string matching like a boss. It uses `Levenshtein Distance `_ to calculate the differences between sequences in a simple-to-use package. - -Requirements -============ - -- Python 2.7 or higher -- difflib -- `python-Levenshtein `_ (optional, provides a 4-10x speedup in String - Matching, though may result in `differing results for certain cases `_) - -For testing -~~~~~~~~~~~ -- pycodestyle -- hypothesis -- pytest - -Installation -============ - -Using PIP via PyPI - -.. code:: bash - - pip install fuzzywuzzy - -or the following to install `python-Levenshtein` too - -.. code:: bash - - pip install fuzzywuzzy[speedup] - - -Using PIP via Github - -.. code:: bash - - pip install git+git://github.com/seatgeek/fuzzywuzzy.git@0.18.0#egg=fuzzywuzzy - -Adding to your ``requirements.txt`` file (run ``pip install -r requirements.txt`` afterwards) - -.. code:: bash - - git+ssh://git@github.com/seatgeek/fuzzywuzzy.git@0.18.0#egg=fuzzywuzzy - -Manually via GIT - -.. code:: bash - - git clone git://github.com/seatgeek/fuzzywuzzy.git fuzzywuzzy - cd fuzzywuzzy - python setup.py install - - -Usage -===== - -.. code:: python - - >>> from fuzzywuzzy import fuzz - >>> from fuzzywuzzy import process - -Simple Ratio -~~~~~~~~~~~~ - -.. code:: python - - >>> fuzz.ratio("this is a test", "this is a test!") - 97 - -Partial Ratio -~~~~~~~~~~~~~ - -.. code:: python - - >>> fuzz.partial_ratio("this is a test", "this is a test!") - 100 - -Token Sort Ratio -~~~~~~~~~~~~~~~~ - -.. code:: python - - >>> fuzz.ratio("fuzzy wuzzy was a bear", "wuzzy fuzzy was a bear") - 91 - >>> fuzz.token_sort_ratio("fuzzy wuzzy was a bear", "wuzzy fuzzy was a bear") - 100 - -Token Set Ratio -~~~~~~~~~~~~~~~ - -.. code:: python - - >>> fuzz.token_sort_ratio("fuzzy was a bear", "fuzzy fuzzy was a bear") - 84 - >>> fuzz.token_set_ratio("fuzzy was a bear", "fuzzy fuzzy was a bear") - 100 - -Process -~~~~~~~ - -.. code:: python - - >>> 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)] - >>> process.extractOne("cowboys", choices) - ("Dallas Cowboys", 90) - -You can also pass additional parameters to ``extractOne`` method to make it use a specific scorer. A typical use case is to match file paths: - -.. code:: python - - >>> process.extractOne("System of a down - Hypnotize - Heroin", songs) - ('/music/library/good/System of a Down/2005 - Hypnotize/01 - Attack.mp3', 86) - >>> process.extractOne("System of a down - Hypnotize - Heroin", songs, scorer=fuzz.token_sort_ratio) - ("/music/library/good/System of a Down/2005 - Hypnotize/10 - She's Like Heroin.mp3", 61) - -.. |Build Status| image:: https://api.travis-ci.org/seatgeek/fuzzywuzzy.png?branch=master - :target: https:travis-ci.org/seatgeek/fuzzywuzzy - -Known Ports -============ - -FuzzyWuzzy is being ported to other languages too! Here are a few ports we know about: - -- Java: `xpresso's fuzzywuzzy implementation `_ -- Java: `fuzzywuzzy (java port) `_ -- Rust: `fuzzywuzzy-rs (Rust port) `_ -- JavaScript: `fuzzball.js (JavaScript port) `_ -- C++: `Tmplt/fuzzywuzzy `_ -- C#: `fuzzysharp (.Net port) `_ -- Go: `go-fuzzywuzz (Go port) `_ -- Free Pascal: `FuzzyWuzzy.pas (Free Pascal port) `_ -- Kotlin multiplatform: `FuzzyWuzzy-Kotlin `_ -- R: `fuzzywuzzyR (R port) `_