Skip to content

Commit 3712ba4

Browse files
committed
update installation guide
1 parent 4541892 commit 3712ba4

File tree

2 files changed

+37
-6
lines changed

2 files changed

+37
-6
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,48 @@ RapidFuzz is a fast string matching library for Python and C++, which is using t
4848
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
4949
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. More details on these performance improvements in form of benchmarks can be found [here](https://github.com/maxbachmann/rapidfuzz/blob/master/Benchmarks.md)
5050

51+
## Requirements
52+
53+
- Python 2.7 or later
54+
- On Windows the [Visual C++ 2019 redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) is required
5155

5256
## Installation
53-
RapidFuzz can be installed using [pip](https://pypi.org/project/rapidfuzz/)
57+
58+
There are several ways to install RapidFuzz, the recommended methods
59+
are to either use `pip`(the Python package manager) or
60+
`conda` (an open-source, cross-platform, package manager)
61+
62+
### with pip
63+
64+
RapidFuzz can be installed with `pip` the following way:
65+
5466
```bash
55-
$ pip install rapidfuzz
67+
pip install rapidfuzz
5668
```
5769

58-
There are pre-built binaries (wheels) for `RapidFuzz` and its dependencies for MacOS (10.9 and later), Linux x86_64 and Windows.
70+
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](https://www.piwheels.org/project/rapidfuzz/).
71+
72+
> :heavy_multiplication_x:   **failure "ImportError: DLL load failed"**
73+
>
74+
> If you run into this error on Windows the reason is most likely, that the [Visual C++ 2019 redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) is not installed, which is required to find C++ Libraries (The C++ 2019 version includes the 2015, 2017 and 2019 version).
75+
5976

60-
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](https://visualstudio.microsoft.com/visual-cpp-build-tools) on Windows.
77+
### with conda
6178

79+
RapidFuzz can be installed with `conda`:
80+
81+
```bash
82+
conda install -c conda-forge rapidfuzz
83+
```
84+
85+
### from git
86+
RapidFuzz can be installed directly from the source distribution by cloning the repository. This requires a C++14 capable compiler.
87+
88+
```bash
89+
git clone https://github.com/maxbachmann/rapidfuzz.git
90+
cd rapidfuzz
91+
pip install .
92+
```
6293

6394
## Usage
6495
```console

docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ template: overrides/main.html
55
# Installation
66

77
=== "Python"
8-
While there are several ways of install RapidFUzz, the recommended methods
8+
While there are several ways of install RapidFuzz, the recommended methods
99
are either by using `pip`(the Python package manager) or
1010
`conda` (an open-source, cross-platform, package manager)
1111

@@ -33,7 +33,7 @@ template: overrides/main.html
3333

3434
## from git
3535

36-
RapidFuzz can be directly used from [GitHub][8] by cloning the
36+
RapidFuzz can be directly used from GitHub by cloning the
3737
repository which might be useful when you want to work on it:
3838

3939
``` sh

0 commit comments

Comments
 (0)