Skip to main content

Korean Romanizer with pronunciation rules based on 국립국어원 표기법

Project description

🇰🇷 한국어로 보기

KOROMAN - Korean Romanizer

KOROMAN is a multilingual Romanizer for Korean text, based on the Revised Romanization system (국립국어원 표기법) with additional pronunciation rules. It converts Hangul syllables into Romanized Latin script across multiple languages: JavaScript, Python, and Java.

🌐 Live Demo


📦 Features

  • Supports Revised Romanization of Korean
  • Applies key Korean phonological rules:
    • Liaison (연음화)
    • Nasal assimilation (비음화)
    • Lateralization (유음화)
    • Fortis/tense consonants (경음화)
  • Provides casing options (lower, upper, capitalized) — accepts full names, short aliases, or numeric codes (1.0.14+)
  • Fully tested in each language

🚀 Getting Started

Python

pip install koroman
from koroman import romanize

# Basic usage
romanize("한글")  # → "hangul"

# With pronunciation rules disabled
romanize("해돋이", use_pronunciation_rules=False)  # → "haedodi"

# With pronunciation rules enabled (default)
romanize("해돋이")  # → "haedoji"

# With different casing options (full names)
romanize("한글", casing_option="uppercase")  # → "HANGEUL"
romanize("안녕 한글", casing_option="capitalize-word")  # → "Annyeong Hangeul"
romanize("안녕\n한글 로마자 변환", casing_option="capitalize-line")  # → "Annyeong\nHangeul romaja byeonhwan"

# 1.0.14+ : short aliases / numeric codes are also accepted
romanize("한글", casing_option="u")    # → "HANGEUL"
romanize("한글", casing_option="uc")   # → "HANGEUL"
romanize("한글", casing_option=1)      # → "HANGEUL"
romanize("안녕 한글", casing_option="cw")   # → "Annyeong Hangeul"
romanize("안녕\n한글 로마자 변환", casing_option=2)  # → "Annyeong\nHangeul romaja byeonhwan"

# Combining options
romanize("해돋이", use_pronunciation_rules=False, casing_option="uc")  # → "HAEDODI"
romanize("해돋이", use_pronunciation_rules=False, casing_option=1)     # → "HAEDODI"

casingOption aliases (1.0.14+)

Canonical Aliases Numeric
lowercase lower, l, lc 0
uppercase upper, u, uc 1
capitalize-line cap-line, cline, cl 2
capitalize-word cap-word, cword, cw 3

Case-insensitive. Unknown / None falls back to lowercase.

📜 LICENSE

MIT License

2025 ⓒ Donghe Youn (Daissue)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

koroman-1.0.14.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

koroman-1.0.14-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file koroman-1.0.14.tar.gz.

File metadata

  • Download URL: koroman-1.0.14.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for koroman-1.0.14.tar.gz
Algorithm Hash digest
SHA256 44553b518f8162261885355deb1584d981885c010c85e74cd965459256584454
MD5 15b6282c6d9001ecb8cc4a5f64c6d07c
BLAKE2b-256 e838fb7aa6f4adee8e891b48862d7cf65852807e21d7e8ac4b03ad98a5d7559f

See more details on using hashes here.

File details

Details for the file koroman-1.0.14-py3-none-any.whl.

File metadata

  • Download URL: koroman-1.0.14-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for koroman-1.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 5d5386767e36df25a443bd6b7ed8903e33c8c3d31e6d306f0b88e64db25dd7ab
MD5 df1edba2653e499d52b88465ce5cf2ac
BLAKE2b-256 1303d2516b3222ebac6c5567767d53346c35918f9ed93e49df244166294f76bd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page