pykakasi


Namepykakasi JSON
Version 2.3.0 PyPI version JSON
download
home_pageNone
SummaryKana kanji simple inversion library
upload_time2024-06-24 04:57:31
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseGPL-3.0-or-later
keywords kakasi nlp
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ========
Pykakasi
========

Overview
========

.. image:: https://readthedocs.org/projects/pykakasi/badge/?version=latest
   :target: https://pykakasi.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://badge.fury.io/py/pykakasi.png
   :target: http://badge.fury.io/py/Pykakasi
   :alt: PyPI version

.. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg
   :target: https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md


``pykakasi`` is a Python Natural Language Processing (NLP) library to transliterate *hiragana*, *katakana* and *kanji* (Japanese text) into *rōmaji* (Latin/Roman alphabet). It can handle characters in NFC form.

Its algorithms are based on the `kakasi`_ library, which is written in C.

* Install (from `PyPI`_): ``pip install pykakasi``
* Install (from `conda-forge`_): ``conda install -c conda-forge pykakasi``
* `Documentation available on readthedocs`_

.. _`PyPI`: https://pypi.org/project/pykakasi/
.. _`conda-forge`: https://github.com/conda-forge/pykakasi-feedstock
.. _`kakasi`: http://kakasi.namazu.org/
.. _`Documentation available on readthedocs`: https://pykakasi.readthedocs.io/en/latest/index.html


Supported python versions
=========================

* pykakasi supports python 3.8, 3.9, 3.10, 3.11, 3.12, 3.13 and pypy3

Usage
=====

Transliterate Japanese text to kana, hiragana and romaji:

.. code-block:: python

    import pykakasi
    kks = pykakasi.kakasi()
    text = "かな漢字"
    result = kks.convert(text)
    for item in result:
        print("{}: kana '{}', hiragana '{}', romaji: '{}'".format(item['orig'], item['kana'], item['hira'], item['hepburn']))

    かな: kana 'カナ', hiragana: 'かな', romaji: 'kana'
    漢字: kana 'カンジ', hiragana: 'かんじ', romaji: 'kanji'


Here is an example that output as similar with furigana mode.

.. code-block:: python

    import pykakasi
    kks = pykakasi.kakasi()
    text = "かな漢字交じり文"
    result = kks.convert(text)
    for item in result:
        print("{}[{}] ".format(item['orig'], item['hepburn'].capitalize()), end='')
    print()

    かな[Kana] 漢字[Kanji] 交じり[Majiri] 文[Bun]




Copyright and License
=====================

PyKakasi::
    Copyright (C) 2010-2024 Hiroshi Miura and contributors(see AUTHORS)

KAKASI Dictionary::
    Copyright (C) 2010-2021 Hiroshi Miura and contributors(see AUTHORS)

    Copyright (C) 1992 1993 1994 Hironobu Takahashi, Masahiko Sato,
    Yukiyoshi Kameyama, Miki Inooka, Akihiko Sasaki, Dai Ando, Junichi Okukawa,
    Katsushi Sato and Nobuhiro Yamagishi

UniDic::
    Copyright (c) 2011-2021, The UniDic Consortium

    All rights reserved.

    Unidic is released under any of the GPL2, the LGPL2.1,
    or the 3-clause BSD License. (See src/data/unidic/BSD.txt)
    PyKakasi relicenses a part of the unidic with GPL3+.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pykakasi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "kakasi, NLP",
    "author": null,
    "author_email": "Hiroshi Miura <miurahr@linux.com>",
    "download_url": "https://files.pythonhosted.org/packages/ad/32/2a8e213fd744459a03864af7cf4c6142ee061fc915757c8152d147b16015/pykakasi-2.3.0.tar.gz",
    "platform": null,
    "description": "========\nPykakasi\n========\n\nOverview\n========\n\n.. image:: https://readthedocs.org/projects/pykakasi/badge/?version=latest\n   :target: https://pykakasi.readthedocs.io/en/latest/?badge=latest\n   :alt: Documentation Status\n\n.. image:: https://badge.fury.io/py/pykakasi.png\n   :target: http://badge.fury.io/py/Pykakasi\n   :alt: PyPI version\n\n.. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg\n   :target: https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md\n\n\n``pykakasi`` is a Python Natural Language Processing (NLP) library to transliterate *hiragana*, *katakana* and *kanji* (Japanese text) into *r\u014dmaji* (Latin/Roman alphabet). It can handle characters in NFC form.\n\nIts algorithms are based on the `kakasi`_ library, which is written in C.\n\n* Install (from `PyPI`_): ``pip install pykakasi``\n* Install (from `conda-forge`_): ``conda install -c conda-forge pykakasi``\n* `Documentation available on readthedocs`_\n\n.. _`PyPI`: https://pypi.org/project/pykakasi/\n.. _`conda-forge`: https://github.com/conda-forge/pykakasi-feedstock\n.. _`kakasi`: http://kakasi.namazu.org/\n.. _`Documentation available on readthedocs`: https://pykakasi.readthedocs.io/en/latest/index.html\n\n\nSupported python versions\n=========================\n\n* pykakasi supports python 3.8, 3.9, 3.10, 3.11, 3.12, 3.13 and pypy3\n\nUsage\n=====\n\nTransliterate Japanese text to kana, hiragana and romaji:\n\n.. code-block:: python\n\n    import pykakasi\n    kks = pykakasi.kakasi()\n    text = \"\u304b\u306a\u6f22\u5b57\"\n    result = kks.convert(text)\n    for item in result:\n        print(\"{}: kana '{}', hiragana '{}', romaji: '{}'\".format(item['orig'], item['kana'], item['hira'], item['hepburn']))\n\n    \u304b\u306a: kana '\u30ab\u30ca', hiragana: '\u304b\u306a', romaji: 'kana'\n    \u6f22\u5b57: kana '\u30ab\u30f3\u30b8', hiragana: '\u304b\u3093\u3058', romaji: 'kanji'\n\n\nHere is an example that output as similar with furigana mode.\n\n.. code-block:: python\n\n    import pykakasi\n    kks = pykakasi.kakasi()\n    text = \"\u304b\u306a\u6f22\u5b57\u4ea4\u3058\u308a\u6587\"\n    result = kks.convert(text)\n    for item in result:\n        print(\"{}[{}] \".format(item['orig'], item['hepburn'].capitalize()), end='')\n    print()\n\n    \u304b\u306a[Kana] \u6f22\u5b57[Kanji] \u4ea4\u3058\u308a[Majiri] \u6587[Bun]\n\n\n\n\nCopyright and License\n=====================\n\nPyKakasi::\n    Copyright (C) 2010-2024 Hiroshi Miura and contributors(see AUTHORS)\n\nKAKASI Dictionary::\n    Copyright (C) 2010-2021 Hiroshi Miura and contributors(see AUTHORS)\n\n    Copyright (C) 1992 1993 1994 Hironobu Takahashi, Masahiko Sato,\n    Yukiyoshi Kameyama, Miki Inooka, Akihiko Sasaki, Dai Ando, Junichi Okukawa,\n    Katsushi Sato and Nobuhiro Yamagishi\n\nUniDic::\n    Copyright (c) 2011-2021, The UniDic Consortium\n\n    All rights reserved.\n\n    Unidic is released under any of the GPL2, the LGPL2.1,\n    or the 3-clause BSD License. (See src/data/unidic/BSD.txt)\n    PyKakasi relicenses a part of the unidic with GPL3+.\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see <http://www.gnu.org/licenses/>.\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "Kana kanji simple inversion library",
    "version": "2.3.0",
    "project_urls": {
        "Source": "https://codeberg.org/miurahr/pykakasi"
    },
    "split_keywords": [
        "kakasi",
        " nlp"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0fe811644fe823e05c583b330e9fb81e3e8fc5d079036512a8300fc157be349d",
                "md5": "599e50ded078ff6f3c69bb2f3eaa3730",
                "sha256": "26d21b090048ff45c6a4d8e962426b7951767216008ec30358e8a9d74af77f29"
            },
            "downloads": -1,
            "filename": "pykakasi-2.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "599e50ded078ff6f3c69bb2f3eaa3730",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 2395003,
            "upload_time": "2024-06-24T04:57:18",
            "upload_time_iso_8601": "2024-06-24T04:57:18.101577Z",
            "url": "https://files.pythonhosted.org/packages/0f/e8/11644fe823e05c583b330e9fb81e3e8fc5d079036512a8300fc157be349d/pykakasi-2.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ad322a8e213fd744459a03864af7cf4c6142ee061fc915757c8152d147b16015",
                "md5": "d7736fcc1a39a7f08b8f62c9dd694535",
                "sha256": "fa052a8e63f59fb8d6569abbe719a8c9f9daf15ed27a67a56ab1705f0f67b0a1"
            },
            "downloads": -1,
            "filename": "pykakasi-2.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d7736fcc1a39a7f08b8f62c9dd694535",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 21752447,
            "upload_time": "2024-06-24T04:57:31",
            "upload_time_iso_8601": "2024-06-24T04:57:31.233428Z",
            "url": "https://files.pythonhosted.org/packages/ad/32/2a8e213fd744459a03864af7cf4c6142ee061fc915757c8152d147b16015/pykakasi-2.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-24 04:57:31",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": true,
    "codeberg_user": "miurahr",
    "codeberg_project": "pykakasi",
    "lcname": "pykakasi"
}
        
Elapsed time: 0.43941s