Skip to main content

日本語テキストにふりがなを付与するツール

Project description

skfurigana

日本語テキストにふりがな(ルビ)を付与し、さらに英数字をカタカナに自動変換するPythonパッケージです。
形態素解析(fugashi + unidic)によるふりがな付与に加え、DeepSeek APIを利用して英数字をカタカナに変換します。

特徴

  • 日本語テキストに自動でふりがなを付与
  • 英数字や記号をカタカナに変換(DeepSeek API利用)
  • シンプルなAPIで非同期処理にも対応

インストール

pip install skfurigana

または、リポジトリをクローンして直接インストールも可能です。

git clone https://github.com/sugarkwork/furigana.git
cd furigana
pip install .

依存パッケージ

  • fugashi[unidic]
  • unidic
  • skpmem
  • json_repair
  • chat_assistant

DeepSeek APIキーの設定

本パッケージの一部機能(英数字のカタカナ変換)には DeepSeek API キーが必要です。
プロジェクトのルートディレクトリに .env ファイルを作成し、以下のようにAPIキーを記載してください。

DEEPSEEK_API_KEY=あなたのAPIキー

使い方

ふりがな付与(同期処理)

from skfurigana import add_furigana

text = "お弁当を食べながら空を見上げているうちに、お弁当箱は空になった。"
result = add_furigana(text)
print(''.join(map(str, result)))
# 出力例: [お(お)][弁(べん)][当(とう)] を [食(た)]べながら[空(そら)]を...

ふりがな+英数字カタカナ変換(非同期処理)

import asyncio
from skfurigana import convert_furigana

async def main():
    text = "LibreChatのdatabase全体をtext形式でdumpする方法について。"
    result = await convert_furigana(text)
    print(''.join(map(str, result)))

asyncio.run(main())
# 出力例: [LibreChat(リブレチャット)]の[database(データベース)]全体を[text(テキスト)]形式で...

英数字のみカタカナ変換(非同期処理)

import asyncio
from skfurigana import KatakanaTranslator

async def main():
    translator = KatakanaTranslator()
    words = ["LibreChat", "database", "text"]
    result = await translator.translate_to_katakana(words)
    print(result)  # {'LibreChat': 'リブレチャット', 'database': 'データベース', ...}

asyncio.run(main())

ライセンス

MIT License

リンク

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skfurigana-0.1.1.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

skfurigana-0.1.1-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file skfurigana-0.1.1.tar.gz.

File metadata

  • Download URL: skfurigana-0.1.1.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.1

File hashes

Hashes for skfurigana-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ba6ba06d3bc9caef58fe25be6ca850c099210e136aa3e02b184d3f23c91f390b
MD5 e53a65075544069214e2a52d33ce4241
BLAKE2b-256 a6ffb8f2a7576a9db061d4b41dcde40f4a4c53ae6bd159331b9d44eac3cdafe2

See more details on using hashes here.

File details

Details for the file skfurigana-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: skfurigana-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.1

File hashes

Hashes for skfurigana-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 78c5902dbdf0eed57eb66f3f05f1853a56b4d3c5c0cbb78b505d12352d817379
MD5 e68eb22102cbfabb1081efb9740c71d5
BLAKE2b-256 86b3a3399e8636a4da7e26d19f1c6bc15843b97100f7ff4bc3e8f61d3668f551

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page