README.en.md

PyKOMORAN

[한국어] | [English]

Introduction

• PyKOMORAN is Python wrapper project for KOMORAN, KOrean MORphical ANalyzer.
• PyKOMORAN is using Py4J for wrapping KOMORAN Java library.
• If you have any issue or question, please leave an issue on PyKOMORAN Project.

Installation

Requirements

• To use PyKomoran, the following requirements must be installed
  • Java 8+ JDK Environment
    • We recommend you use OracleJDK / OpenJDK.
  • Python 3.4+
    • We recommend you use Python 3.4 or higher.
  • Py4J, 0.10 (or higher)
    • This will be installed when installing PyKomoran using pip.

How to install

• You can install PyKomoran using pip.

  pip install PyKomoran

• Or, just clone this repository and install by yourself.

  git clone https://github.com/shineware/PyKOMORAN
  cd PyKOMORAN/python
  python setup.py install

• Please refer to installation document for detailed installation method.

Usage

Quick start

• After import dependencies, create a Komoran instance.

  from PyKomoran import *
  komoran = Komoran("STABLE")

• After then, run analyzing method.

  komoran.get_plain_text("① 대한민국은 민주공화국이다.")
  # # Result
  # '①/SW 대한민국/NNP 은/JX 민주/NNP 공화국/NNG 이/VCP 다/EF ./SF'

Usage in detail

• Please refer KOMORAN Document site for more information.

Citation

• Please use BibTeX below.

  @misc{komoran,
    author = {Junsoo Shin, Junghwan Park, Geunho Lee},
    title = {KOMORAN},
    publisher = {GitHub},
    journal = {GitHub repository},
    howpublished = {\url{https://github.com/shineware/PyKOMORAN}}
  }

License

• PyKOMORAN is distributed with the Apache 2.0 license, same as KOMORAN. See LICENSE for more information.

Contributing

• We're always happy to receive any contributions including code, bug reports and documentation fixes.
• Please visit our Website and/or Project Organization at GitHub for more information.
• Or, if you have any necessary features or suggestion? Please leave your idea on Request to add new feature