https://github.com/hitblast/avnie

A fast & user-friendly command-line interface (CLI) for avro.py.
https://github.com/hitblast/avnie

avro-keyboard bangla-keyboard cli-app cli-tool command-line python-package python3

Last synced: 4 months ago
JSON representation

A fast & user-friendly command-line interface (CLI) for avro.py.

• Host: GitHub
• URL: https://github.com/hitblast/avnie
• Owner: hitblast
• License: mit
• Created: 2024-07-28T18:01:37.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-12-18T12:16:30.000Z (6 months ago)
• Last Synced: 2025-12-21T16:37:55.021Z (5 months ago)
• Topics: avro-keyboard, bangla-keyboard, cli-app, cli-tool, command-line, python-package, python3
• Language: Python
• Homepage: https://pypi.org/project/avnie/
• Size: 7.81 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


#  avnie

Command-line interface to avro.py; transliteration in the terminal.

[![Downloads](https://static.pepy.tech/personalized-badge/avnie?period=total&units=international_system&left_text=Downloads)](https://pepy.tech/project/avnie)

![Python Version](https://img.shields.io/pypi/pyversions/avro.py.svg?label=Python)

![License](https://img.shields.io/pypi/l/avnie.svg?label=License)

[![Tests & Lints CI](https://github.com/hitblast/avnie/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/hitblast/avnie/actions/workflows/tests.yml)



## 🔨 Installation

```sh

# Install using uv.

uv tool install avnie

# Or, using pip:

pip install avnie

```

## 🚀 Usage

### Command Mode

```sh

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

```sh

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

```sh

$ 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.).

```sh

# Add this to your shell configuration file.

export AVRO_INTERACTIVE=1

```

---

## Development

avnie is based on the project structure provided by [uv](https://github.com/astral-sh/uv), and to get a simple setup ongoing, just use the follwoing commands:

```bash

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

```bash

# run this directly

pytest .

```

## License

Licensed under the [MIT License](https://github.com/hitblast/avnie/blob/main/LICENSE).