pysinrom 0.1.0

Python tools for Sinitic romanization, currently only as research utilities for conversion between Jyutping and CantRomZJ1

PySinRom

Installation

After publication on PyPI:

pip install pysinrom

For local installation from the project directory:

python -m pip install .

Usage

from pysinrom import (
    jyutping_to_cantromzj1,
    cantromzj1_to_jyutping,
)

cantromzj1, syllables = jyutping_to_cantromzj1("hoeng1gong2")
print(cantromzj1)
# heong1A|55gong2A|35

jyutping, syllables = cantromzj1_to_jyutping("heong1A|55gong2A|35")
print(jyutping)
# hoeng1gong2

Space-separated input and output are also supported:

result = jyutping_to_cantromzj1(
    "hoeng1 gong2",
    output_separator=" ",
    return_mode="string",
)
print(result)
# heong1A|55 gong2A|35

Main functions

• jyutping_to_cantromzj1()
• jyutping_syllable_to_cantromzj1()
• cantromzj1_to_jyutping()
• cantromzj1_syllable_to_jyutping()
• parse_cantromzj1()
• parse_cantromzj1_syllable()

The default return mode for full-string conversion is a tuple containing the joined output string and a list of converted syllables. Set return_mode="string" or return_mode="list" to request only one representation.

Development status

This is research software released as an alpha version. The current implementation focuses on the romanization correspondences described in the accompanying anonymous manuscript.

License

MIT License.