# PYKAKASI documentation

This is the documentation for Pykakasi library and utility. pykakasi is a library and utility implemented KAKASI functionality in Python. KAKASI was originaly built to convert Japanese text to roman form.

pykakasi is a free software, and available on GitHub project.

`wakati` is an implementation of kakasi's wakati gaki option.

Command Line Options

  Command line options

Programming Interface

  Application programming interface and options

Pykakasi authors

  PyKAKASI authors and credits

Copyright and License

  Copyright and license

Table of contents

  Access to all of document contents

Glossary

  Glossary of Japanese linguistic terms

## Supported python versions

Pykakasi supports python 2.7, python 3.5, 3.6, 3.7, 3.8 and PyPy.

It may work with python 2.6, 3.3, 3.4 and pypy3 but these are not tested now.

## Dependency

It depends on klepto for providing a mapping database.

## About KAKASI

KAKASI is the language processing filter to convert Kanji characters to Hiragana, Katakana or Romaji [2] and may be helpful to read Japanese documents.

The name "KAKASI" is the abbreviation of "kanji kana simple inverter" and the inverse of SKK "simple kana kanji converter" which is developed by Masahiko Sato at Tohoku University. The most entries of the kakasi dictionary is derived form the SKK dictionaries. If you have some interests in the naming of "KAKASI", please consult to Japanese-English dictionary. :-)

## Copyright and License

Copyright 2010-2019 Hiroshi Miura <miurahr@linux.com>

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/>.

# Table of contents

- Programming Interface
  - Conversion Usage
  - Old API (v1.2)
- Command Line Options
  - Executable Options
  - Mode Options
  - Conversion Options
  - Behavior Options
- Pykakasi authors
- Contribution guide
  - Resources
  - Bug triage
  - Send patch
  - CI tests
  - Local test
- PyKakasi ChangeLog
  - Unreleased
  - v2.3.0 (24, June 2024)
  - v2.2.0 (22, June 2021)
  - v2.1.1 (16, May 2021)
  - v2.1.0 (6, May 2021)
  - v2.0.8 (4, May 2021)
  - v2.0.7 (26, Feb. 2021)
  - v2.0.6 (7, Feb. 2021)
  - v2.0.5 (5, Feb. 2021)
  - v2.0.4 (26, Nov. 2020)
  - v2.0.3 (25, Nov. 2020)
  - v2.0.2 (23, Jul. 2020)
  - v2.0.1 (23, Jul. 2020)
  - v2.0.0 (31, May. 2020)
- PyKakasi ChangeLog before v1.0
  - v2.0.0 (31, May. 2020)
  - v2.0.0b1 (9, May. 2020)
  - v2.0.0a6 (30, Mar. 2020)
  - v2.0.0a5 (23, Mar. 2020)
  - v2.0.0a4 (20, Mar. 2020)
  - v2.0.0a3 (18, Mar. 2020)
  - v2.0.0a2 (16, Mar. 2020)
  - v2.0.0a1 (14, Mar. 2020)
  - v1.2 (26, Sep, 2019)
  - v1.1 (16, Sep, 2019)
  - v1.1b2 (14, Sep, 2019)
  - v1.1b1 (6, Sep, 2019)
  - v1.1a1 (8, Jul, 2019)
  - v1.0-rc1 (29, June, 2019)
  - v0.96 (12, June, 2019)
  - v0.95 (8, June, 2019)
  - v0.94 (16, Feb, 2019)
  - v0.93 (3, May, 2018)
  - v0.92 (30, Apr., 2018)
  - v0.91 (29, Apr., 2018)
  - v0.90 (29, Mar., 2018)
  - v0.83 (29, Mar., 2018)
  - v0.82 (29, Mar., 2018)
  - v0.80 (28, Mar., 2018)
  - v0.28 (26, Mar., 2018)
  - v0.26 (26, Mar., 2018)
  - v0.25 (25, Mar., 2018)
  - v0.23 (25, May., 2014)
  - v0.22 (3, May., 2014)
  - v0.21 (27, April., 2014)
  - v0.20 (27, April., 2014)
  - Version 0.10 (25, April, 2014)
- Glossary

# Indices and tables

- 索引

- 検索ページ

- Glossary

Footnotes

[2]

"Romaji" is alphabetical description of Japanese pronunciation.