https://github.com/shineware/PyKOMORAN
(Beta) PyKOMORAN is wrapped KOMORAN in Python using Py4J.
https://github.com/shineware/PyKOMORAN
komoran korean korean-analysis korean-nlp korean-text-processing korean-tokenizer morphological-analyser nlp py4j pypi-packages
Last synced: about 1 month ago
JSON representation
(Beta) PyKOMORAN is wrapped KOMORAN in Python using Py4J.
- Host: GitHub
- URL: https://github.com/shineware/PyKOMORAN
- Owner: shineware
- License: apache-2.0
- Created: 2019-03-15T12:13:20.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-27T10:32:37.000Z (about 1 month ago)
- Last Synced: 2025-04-27T11:38:51.906Z (about 1 month ago)
- Topics: komoran, korean, korean-analysis, korean-nlp, korean-text-processing, korean-tokenizer, morphological-analyser, nlp, py4j, pypi-packages
- Language: Python
- Homepage: https://pydocs.komoran.kr
- Size: 34.8 MB
- Stars: 42
- Watchers: 5
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.en.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hangul - PyKOMORAN - PyKOMORAN is wrapped KOMORAN in Python using Py4J. (Programming Languages / Python)
README
# PyKOMORAN
[](https://pypi.org/project/PyKomoran)
[](https://pypi.org/project/PyKomoran)
[](https://pypi.org/project/PyKomoran)
[](https://www.apache.org/licenses/LICENSE-2.0)
[[한국어](README.md)] | [[English](README.en.md)]
## Introduction
* PyKOMORAN is Python wrapper project for [KOMORAN, KOrean MORphical ANalyzer](https://github.com/shin285/KOMORAN).
* PyKOMORAN is using [Py4J](https://github.com/bartdag/py4j) for wrapping [KOMORAN Java library](https://github.com/shin285/KOMORAN).
* If you have any issue or question, please leave an issue on [PyKOMORAN Project](https://github.com/shineware/PyKOMORAN/issues).
## 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](https://www.py4j.org/install.html), 0.10 (or higher)
* This will be installed when installing PyKomoran using `pip`.
### How to install
* You can install PyKomoran using `pip`.
```sh
pip install PyKomoran
```
* Or, just clone this repository and install by yourself.
```sh
git clone https://github.com/shineware/PyKOMORAN
cd PyKOMORAN/python
python setup.py install
```
* Please refer to [installation document](https://pydocs.komoran.kr/firststep/installation.html?utm_source=GitHub&utm_medium=Referral&utm_campaign=PyKomoran) for detailed installation method.
## Usage
### Quick start
* After import dependencies, create a Komoran instance.
```python
from PyKomoran import *
komoran = Komoran("STABLE")
```
* After then, run analyzing method.
```python
komoran.get_plain_text("① 대한민국은 민주공화국이다.")
# # Result
# '①/SW 대한민국/NNP 은/JX 민주/NNP 공화국/NNG 이/VCP 다/EF ./SF'
```
### Usage in detail
* Please refer [KOMORAN Document site](https://pydocs.komoran.kr/firststep/tutorial.html?utm_source=GitHub&utm_medium=Referral&utm_campaign=PyKomoran) for more information.
## Citation
* Please use BibTeX below.
```tex
@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](https://github.com/shin285/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](https://www.shineware.co.kr/products/komoran/#demo?utm_source=GitHub&utm_medium=Referral&utm_campaign=PyKomoran) and/or [Project Organization at GitHub](https://github.com/komoran) for more information.
* Or, if you have any necessary features or suggestion? Please leave your idea on [Request to add new feature](https://github.com/shineware/PyKOMORAN/issues/new?template=FEATURE_REQUEST.md)