Inspirations

This package is inspired from Rifat Nabi's jsAvroPhonetic. So far, the code is a direct (and shameless) translation of jsAvroPhonetic into Python.

With Pip

Option 1. Using Pip (the easy way) (recommended):

$ sudo pip install PyAvroPhonetic

Option 2. Using Pip in a Virtualenv (needs virtualenv):

$ virtualenv pyAvroPhonetic
$ cd pyAvroPhonetic
$ source bin/activate
$ pip install PyAvroPhonetic

Without Pip

Option 3. Using Git (needs git):

$ git clone https://github.com/kaustavdm/pyAvroPhonetic
$ cd pyAvroPhonetic
$ python setup.py build
$ sudo python setup.py install

Option 4. Using Git in a Virtualenv (needs git and virtualenv):

$ virtualenv pyAvroPhonetic
$ cd pyAvroPhonetic
$ source bin/activate
$ git clone https://github.com/kaustavdm/pyAvroPhonetic
$ cd pyAvroPhonetic
$ python setup.py build
$ python setup.py install

Note for developers

Coding style follows PEP 8 along with PEP 257 for Docstring conventions. Unit tests are run using the Nose library and syntax and style checking is done with Pylint.

Please install these two libraries in your development environment. The tests/requirements.txt file specifies testing dependencies. To install them with pip:

$ sudo pip install -r tests/requirements.txt

Pylint is used with some modifications to the default configuration. The notable ones are:

• W0142 is ignored to allow usage of “magic methods”

• Maximum branches in function body: 20

• Maximum statements in function body: 100

For others please see the [Design] section in pylint-rc.ini. Our target is to keep up a score of 10.0/10 in Pylint’s reports. Tests on Travis will fail if Pylint doesn’t give 10.0/10. This is intentationally used to ensure uniform code structure and quality.

Run unit tests from the root of the repository:

$ nosetests --exe -v

Run pylint from root of the repository:

$ pylint --rcfile=pylint-rc.ini pyavrophonetic

We need more testers

If you find any bugs, please report them in the Issues queue. As always, before you report any new issue, please check that it has not been already posted by someone else.