1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
# Overview
**jellyfish** is a library for approximate & phonetic matching of strings.
Source: [https://github.com/jamesturk/jellyfish](https://github.com/jamesturk/jellyfish)
Documentation: [https://jamesturk.github.io/jellyfish/](https://jamesturk.github.io/jellyfish/)
Issues: [https://github.com/jamesturk/jellyfish/issues](https://github.com/jamesturk/jellyfish/issues)
[](https://badge.fury.io/py/jellyfish)
[](https://github.com/jamesturk/jellyfish/actions?query=workflow%3A%22Python+package)
[](https://coveralls.io/r/jamesturk/jellyfish)
## Included Algorithms
String comparison:
* Levenshtein Distance
* Damerau-Levenshtein Distance
* Jaccard Similarity
* Jaro Distance
* Jaro-Winkler Distance
* Match Rating Approach Comparison
* Hamming Distance
Phonetic encoding:
* American Soundex
* Metaphone
* NYSIIS (New York State Identification and Intelligence System)
* Match Rating Codex
## Implementations
Each algorithm has Rust and Python implementations.
The Rust implementations are used by default. The Python
implementations are a remnant of an early version of
the library and will probably be removed in 1.0.
To explicitly use a specific implementation, refer to the appropriate module::
``` python
import jellyfish._jellyfish as pyjellyfish
import jellyfish.rustyfish as rustyfish
```
If you've already imported jellyfish and are not sure what implementation you
are using, you can check by querying `jellyfish.library`.
``` python
if jellyfish.library == 'Python':
# Python implementation
elif jellyfish.library == 'Rust':
# Rust implementation
```
## Example Usage
``` python
>>> import jellyfish
>>> jellyfish.levenshtein_distance('jellyfish', 'smellyfish')
2
>>> jellyfish.jaro_similarity('jellyfish', 'smellyfish')
0.89629629629629637
>>> jellyfish.damerau_levenshtein_distance('jellyfish', 'jellyfihs')
1
>>> jellyfish.metaphone('Jellyfish')
'JLFX'
>>> jellyfish.soundex('Jellyfish')
'J412'
>>> jellyfish.nysiis('Jellyfish')
'JALYF'
>>> jellyfish.match_rating_codex('Jellyfish')
'JLLFSH'
```
|
