indic-itn 0.1.0

Inverse Text Normalization (ITN) for Indic languages

indic-itn

Inverse Text Normalization (ITN) for Indic languages.

Installation

To install the package in editable mode for development:

pip install -e .

To install dev dependencies as well:

pip install -e ".[dev]"

Usage

from indic_itn import HindiITN

# Instantiate the ITN processor
itn = HindiITN()

# Normalize text (placeholder)
# text = "कक्षा दो" -> "कक्षा 2"

Development and Tooling

This project uses modern tooling for maintaining code quality:

Code Formatting and Linting

We use Ruff and Black for formatting, linting, and imports sorting.

# Run Ruff lint check
ruff check .

# Run Ruff formatter check
ruff format --check .

# Run Black formatting check
black --check .

Type Checking

We use MyPy for static type checking.

mypy src tests

Running Tests

We use Pytest for unit testing along with pytest-cov for coverage.

pytest

Pre-commit Hooks

To set up pre-commit hooks:

pre-commit install

To run hooks on all files manually:

pre-commit run --all-files