Installation

Requirements

Requirement	Version
Python	>= 3.9
Dependencies	nltk >= 3.8, inflect >= 6.0

Dependencies are installed automatically with revo-norm.

Install via uv (Recommended)

uv is a fast Python package manager.

# Add to your project
uv add revo-norm

Install via pip

pip install revo-norm

Install from Source

Use this method if you need to modify revo-norm or want the latest development version.

# Clone the repository
git clone https://github.com/khursanirevo/revo-norm.git
cd revo-norm

# Install in development mode
uv sync

Note

Install uv first if you don't have it:

curl -LsSf https://astral.sh/uv/install.sh | sh

Verify Installation

Run this quick test to confirm revo-norm is installed correctly:

python -c "from revo_norm import normalize_text; print(normalize_text('Hello 123', language='en'))"

You should see output like:

Hello one hundred and twenty three

Development Dependencies

If you are contributing to revo-norm, install the development toolchain:

# Clone and enter the repo
git clone https://github.com/khursanirevo/revo-norm.git
cd revo-norm

# Install with dev dependencies
uv sync --group dev

# Install with docs dependencies
uv sync --group docs

# Install everything
uv sync --all-groups

Dev Tools Included

Tool	Purpose
pytest >= 8.4.2	Test runner
pytest-cov >= 7.0.0	Coverage reporting
ruff >= 0.8.0	Linting and formatting

Common Dev Commands

# Run linter
uv run ruff check revo_norm/

# Auto-fix lint issues
uv run ruff check revo_norm/ --fix

# Format code
uv run ruff format revo_norm/

# Run tests
uv run pytest -v

# Run tests with coverage
uv run pytest --cov --cov-report=term-missing

Tip

Run uv run ruff check revo_norm/ and uv run pytest -q before every commit to catch issues early.