🔨 Installation

# Install using uv.
uv tool install avnie

# Or, using pip:
pip install avnie

🚀 Usage

Command Mode

# Get basic help regarding usage.
$ avnie --help

# Parse from English.
$ avnie parse "ami banglay gan gaite bhalObasi"

# Reverse back!
$ avro reverse "আমি বাংলায় গান গাইতে ভালোবাসি"

Some universal flags for each commands include:

# Automatically copy the output to clipboard.
$ avnie parse "oiTa ke?" --copy-on-success  # or -c

# Get text from clipboard.
$ avnie parse --from-clip # or -f

# Toggle between remap and full manual mode.
$ avnie parse "wikipedia"  # remap
$ avnie parse "wikipedia" --ignore-remap  # no remap (can also use --i)

# Convert to Bijoy on output.
$ avnie parse "tumi ke?" --bijoy  # or -b

🔸 Interactive Mode

You can start the interactive mode by running the following command:

$ avnie interactive

If you'd like to make it the default way of using the tool, set the AVRO_INTERACTIVE environment variable to 1 in your shell configuration file (e.g. .bashrc, .zshrc, etc.).

# Add this to your shell configuration file.
export AVRO_INTERACTIVE=1

Development

avnie is based on the project structure provided by uv, and to get a simple setup ongoing, just use the follwoing commands:

# clone
git clone https://github.com/hitblast/avnie.git

# synchronize with uv
cd avnie && uv sync --all-extras

A testing suite is included with the following deps: pytest, pytest-mock

# run this directly
pytest .

License

Licensed under the MIT License.