Jamo: Hangul Character Analysis

.. image:: https://github.com/JDongian/python-jamo/actions/workflows/ci.yml/badge.svg :target: https://github.com/JDongian/python-jamo/actions/workflows/ci.yml

.. image:: https://readthedocs.org/projects/python-jamo/badge/?version=latest :target: https://readthedocs.org/projects/python-jamo/?badge=latest

Python-jamo is a Python Hangul syllable decomposition and synthesis library for working with Hangul characters and jamo.

Currently in beta release, function names are subject to change, but there is coverage for nearly all Hangul-related codepoints under Unicode 7.0.

Originally designed to help students identify difficult-to-spell words containing (ㅔ,ㅐ) or (ㅗ,ㅜ), this project hopes to fill the niche of Korean phonetic and spelling analysis.

Installation

To install Jamo from pypi_, simply:

.. code-block:: bash

$ pip install jamo

The jamo module is Python 3 only. Viva the bleeding edge!

Documentation

Documentation is available at ReadTheDocs in English_.

Contributing

Like this project or want to help? Take a look at the issues! I'm active on github, and will review pulls. I'm open to email as well, so please contact me if you have any ideas for this project.

License

Apache 2.0 licensed.

Anyone is free to use the software for any purpose, to distribute it, to modify it, and to distribute modified versions of the software, under the terms of the license, without concern for royalties.

.. _pypi: https://pypi.python.org/pypi/jamo .. _English: http://python-jamo.readthedocs.org/en/latest/ .. _Korean: http://python-jamo.readthedocs.org/ko/latest/