fast-phonetic 0.1.0

No project description provided

fast-phonetic

Fast Phonetic algoritihms in Python, using Rust and rphonetic


· Report Bug · Request Feature

About The Project

All the existing libraries I saw in Python seemed dead. They also seemed to be lacking in modern CI practices. Plus Rust is cool

Currently we have

• Support for all rphonetic encoders besides BeiderMorse and DanitchMokotoff

Getting Started

Installation

pip install fast_phonetic

(back to top)

Usage

import fast_phonetic

# Soundex
soundex = fast_phonetic.encode_word("foo", "soundex")
metaphone = fast_phonetic.encode_word("foo", "metaphone")
double_metaphone = fast_phonetic.encode_word("foo", "double_metaphone")

bad_value = fast_phonetic.encode_word("foo", "bleh-encoder") # Raises NotImplemented error

(back to top)

Roadmap

• Add Tests
• Add auto docs
• Improved Multi-language support

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)