Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Soundex algorithm for russian, english and finnish languages

Project description

# Soundex for Russian
Russian, English and Finnish Phonetic algorithm based on Soundex.

Package has both implemented phoneme transformation into letter-number sequence and distance engine for comparison of Soundex sequences (based on Levenstein distance).

### Quick start
1. Install this package via ```pip```

```python
pip install ru-soundex
```

2. Import Soundex algorithm.

Package supports a lot of opportunities, it's possible to cut a result sequence (like in the original Soundex version) or also code vowels.

```python
from ru_soundex.soundex import RussianSoundex

soundex = RussianSoundex(delete_first_letter=True)
soundex.transform('ёлочка')
...

J070530

soundex = Soundex(delete_first_letter=True, code_vowels=True)
soundex.transform('ёлочка')
...

JA7A53A
```

> A structure of the library is scalable, `RussianSoundex` class inherits basic class `Soundex` (original for English language). In order to extend our algorithm, you need just inherit own class from `Soundex` and override methods.

3. Import Soundex distance for usage of string comparision

```python
from ru_soundex.distance import SoundexDistance

soundex = RussianSoundex(delete_first_letter=True)
soundex_distance = SoundexDistance(soundex)
soundex_distance.distance('ёлочка', 'йолочка')
...

0
```

Project details


Download files

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

Files for ru-soundex, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size ru_soundex-1.1.1-py3-none-any.whl (6.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size ru_soundex-1.1.1.tar.gz (4.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page