pynysiis 1.0.4

Requirements

Python 2.7 and later.

Setup

You can install this package by using the pip tool and installing:

$ pip install pynysiis

Or:

$ easy_install pynysiis

Usage Example

# Basic Usage
from nysiis import NYSIIS

# Create an instance of the NYSIIS class
nysiis = NYSIIS()

# Encode a string using the NYSIIS instance
name = "Watkins"
coded_name = nysiis.encode(name)
print(coded_name) # Output: "WATCAN"


## Comparing Names
from nysiis import NYSIIS

# Create an instance of the NYSIIS class
nysiis = NYSIIS()

name1 = "John Smith"
name2 = "John Smyth"

coded_name1 = nysiis.encode(name1)
coded_name2 = nysiis.encode(name2)

if coded_name1 == coded_name2:
    print("The names are likely to be the same.")
else:
    print("The names are different.")

# Output:
# The names are likely to be the same.


## Handling different names
from nysiis import NYSIIS

# Create an instance of the NYSIIS class
nysiis = NYSIIS()

names = ["Watkins", "Robert Johnson", "Samantha Williams", "Olanrewaju Akinyele",
        "Obinwanne Obiora", "Abdussalamu Abubakar", "Virat Kohli", "Usman Shah"]

for name in names:
    coded_name = nysiis.encode(name)
    print(f"Original: {name}, NYSIIS: {coded_name}")

    # Output:
    # Original: Watkins, NYSIIS: WATCAN
    # Original: Robert Johnson, NYSIIS: RABART
    # Original: Samantha Williams, NYSIIS: SANANT
    # Original: Olanrewaju Akinyele, NYSIIS: OLANRA
    # Original: Obinwanne Obiora, NYSIIS: OBAWAN
    # Original: Abdussalamu Abubakar, NYSIIS: ABDASA
    # Original: Virat Kohli, NYSIIS: VARATC
    # Original: Usman Shah, NYSIIS: USNANS

Reference

@inproceedings{Rajkovic2007,
  author    = {Petar Rajkovic and Dragan Jankovic},
  title     = {Adaptation and Application of Daitch-Mokotoff Soundex Algorithm on Serbian Names},
  booktitle = {XVII Conference on Applied Mathematics},
  editors   = {D. Herceg and H. Zarin},
  pages     = {193--204},
  year      = {2007},
  publisher = {Department of Mathematics and Informatics, Novi Sad},
  url       = {https://jmp.sh/hukNujCG}
}

Additional References

• Commission Implementing Regulation (EU) 2016/480

• Commission Implementing Regulation (EU) 2023/2381

License

This project is licensed under the MIT License.

Copyright

Copyright © 2024 Finbarrs Oketunji. All Rights Reserved.