avro-py 2023.12.30

A modern Pythonic implementation of Avro Phonetic.

avro.py

A modern Pythonic implementation of the popular Bengali phonetic-typing software Avro Phonetic.

Checks	Status
usability
pretty code
style enforcement

Overview

avro.py, being a Python package, provides a text parser that converts English text written in Roman script to its phonetic equivalent of Bengali. It implements the Avro Phonetic Dictionary Search Library by Mehdi Hasan Khan.

The original project (pyAvroPhonetic) can only be used on versions up to Python 2.7 and doesn't contain proper support for Python's third major version AKA Python 3. It is noteworthy that Python 2 has officially been deprecated by the original maintainers and its usage is being discouraged overall.

Inspirations

This package is inspired from Rifat Nabi's jsAvroPhonetic library and derives from Kaustav Das Modak's pyAvroPhonetic.

Installation

This package requires Python 3.8 or higher to be used inside your development environment.

# Install / upgrade.
$ pip install -U avro.py

Usage Guide

As of now, you can easily use avro.py by importing the module and calling the primary parse function.

# Imports.
import avro

# Parsing some text.
parsed_text = avro.parse('ami banglay gan gai.')
print(parsed_text)

Also, you can reverse unicode Bengali to English text as well (new, doesn't contain phonetic rules).

# Imports.
import avro

# Reversing some text.
reversed_text = avro.reverse('আমার সোনার বাংলা।')
print(reversed_text)

Other use cases include your terminal, literally!

Contributing

:octocat: Fork -> Do your changes -> Send a Pull Request, it's that easy!

---

Additional Developer Notes

In short, avro.py doesn't depend on any third-party libraries. However, if you'd like to contribute to the project, you'll need a handful of such useful tools.

• ruff - linter
• pytest - testing framework
• black - formatting

# Installing the required developer toolchain.
$ python3 -m pip install -r dev-requirements.txt

# Running pytest.
$ python3 -m pytest --verbose

# The results should appear onwards.
# The --verbose / -v flag is used to show all the test results in detail.

We're looking for bug hunters, by the way!

If you come across any kind of bug or wanna request a feature, please let us know by opening an issue here. We do need more ideas to keep the project alive and running, don't we? :P

---

Acknowledgements

• Mehdi Hasan Khan for originally developing and maintaining Avro Phonetic.
• Rifat Nabi for porting it to Javascript.
• Sarim Khan for writing ibus-avro which helped to clarify my concepts further.
• Kaustav Das Modak for porting Rifat Nabi's JavaScript iteration to Python 2.
• Md Enzam Hossain for helping him understand the ins and outs of the Avro dictionary and the way it works.

License

Licensed under the MIT License.