Skip to content

Nepali Unicoder Documentation

Welcome to the official documentation for Nepali Unicoder, a robust Python package for converting Romanized Nepali text and Preeti font text into Unicode Devanagari script.

Overview

Nepali Unicoder provides tools to handle the complexities of Devanagari script conversion, including contextual rules for Preeti font and a greedy matching algorithm for Roman transliteration.

Documentation Sections

  • Getting Started

    Learn how to install and use the package via CLI and Python API.

  • Preeti Mappings

    A comprehensive guide to Preeti character mappings and rules.

  • API Reference

    Technical details about the project's classes and methods.

How it Works

graph TD
    A[Input Text] --> B{Mode?}
    B -- Roman --> C[Trie-based Greedy Match]
    B -- Preeti --> D[Dual-Phase Conversion]
    D --> E[Character Mapping]
    E --> F[Contextual Processing]
    C --> G[Unicode Output]
    F --> G
  • Greedy Phonetic Matching: Prioritizes longer matches for more accurate Roman-to-Unicode conversion.
  • Extensive Preeti Support: Over 40+ mappings and contextual rules (reph, matras, combined forms).
  • English Block Support: Use {} to preserve English text within converted strings.
  • Custom Overrides: Add custom word-level mappings via word_maps.json.