Skip to main content

avro.py

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

Downloads Python Version License


Checks Status
usability Unit Tests
pretty code Linting
style enforcement Formatting

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.

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

Metadata

Release files for avro-py 2024.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for avro-py 2024.1.1
File Size Uploaded Provenance Actions
avro.py-2024.1.1.tar.gz 16.6 kB Without provenance Details for avro.py-2024.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for avro-py 2024.1.1
File Interpreter ABI Platform Actions
avro.py-2024.1.1-py3-none-any.whl Python 3 none any Details for avro.py-2024.1.1-py3-none-any.whl

Total release size: 29.8 kB

Release files / avro.py-2024.1.1.tar.gz

Download URL avro.py-2024.1.1.tar.gz
Size 16.6 kB
Tags Source
SHA-256 checksum
How to use checksums
4421e5a33b26d2f0e8ae68e6b610b20c901c59ed5d240c4bf3edb19cd6f143a4
BLAKE2b-256 checksum
How to use checksums
16172e7afe23ba340f15ac5d9a02d6c564df0478f35002629c22aa05d3f3e57e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.7

Release files / avro.py-2024.1.1-py3-none-any.whl

Download URL avro.py-2024.1.1-py3-none-any.whl
Size 13.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b3d4b6ce2a0192eafdcaf15b515431efad6ff86d2a60fea457dac40ca1232876
BLAKE2b-256 checksum
How to use checksums
255b68e367ddf4460dcc49f02241d4231d71de46c5249d65a6170bcae011f780
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.7

Security for avro-py 2024.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2024.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page