avro-py 2024.6.23

A modern Pythonic implementation of Avro Phonetic.

avro.py

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

⚡ Overview

avro.py provides a fully fledged, batteries-included text parser which can parse, reverse and even convert English Roman script into its phonetic equivalent (unicode) of Bengali. At its core, it implements an extensively modified version of 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 avro.py

# Install with integrated CLI tool.
$ pip install avro.py[cli]

🔖 Usage Guide

1. parse()

This is the most basic use case for avro.py, which includes parsing English Roman script to unicode Bengali:

# Imports.
import avro

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

2. parse(bijoy=True)

Alternatively, we can generate the same output, but in compliance with the Bijoy Keyboard format:

# Parsing some text in Bijoy!
output = avro.parse('tumi emon keno?', bijoy=True)

3. to_bijoy()

We can also use avro.py to convert existing unicode Bengali to its Bijoy Keyboard equivalent:

# Converting some text.
bijoy_text = avro.to_bijoy('আমি বাংলায় গান গাই।')

4. reverse()

Finally, you can reverse unicode Bengali to English as well (newly added).

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

---

🔖 Command Line Usage

Alternatively, instead of using avro.py from within your Python project, you can also use it as a simple, tiny command-line interface for easy parsing and reversing of text.

Here are some examples for you to get started with:

# Main help section.
$ avro --help  # or, use: avro <command> --help

# Parsing some text.
$ avro parse "tumi onek bhalO!"
$ avro parse --bijoy "amio kharap na, taina?"  # (bijoy keyboard format)

# Reversing.
$ avro reverse "তাই তো!"

# Using additional flags to ease workflow.
$ avro parse --from-clip  # (fetching input from clipboard)
$ avro parse "asolei!" --copy  # (copying output to clipboard)
$ avro parse --from-clip --copy  # (clipboard input -> output)

🛠️ 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.

Poetry has been used to manage the project's dependencies and virtual environment. You can install it by following the instructions here. The dependencies have been configured using the pyproject.toml file and doesn't require manual installation. Simply set up your developer environment using the following commands:

# Set up virtual environment and activate it.
$ python3 -m venv venv && source venv/bin/activate

# Setup project using Poetry.
$ poetry install --sync --all-extras

Later, you can run the tests provided with the project using the following command:

# Run unit tests.
$ poetry run pytest .

🐛 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.