Cutlet项目技术文档

Cutlet项目技术文档

cutlet 项目地址: https://gitcode.com/gh_mirrors/cu/cutlet

Cutlet是一款强大的Python工具，专为将日语转换成罗马字（Romaji）而设计。本文档旨在提供全面指导，帮助您快速上手并深入理解Cutlet的功能。

安装指南

基础安装

通过pip，您可以轻松地安装Cutlet：

pip install cutlet

请注意，为了确保Cutlet能够正常工作，您可能还需要安装MeCab的词典。对于初学者，推荐使用体积较小但功能足够的unidic-lite：

pip install unidic-lite

项目使用说明

命令行工具

Cutlet提供了命令行界面供快速测试。运行cutlet后，程序会读取标准输入中的每一行文本并进行罗马字转换。您可以通过参数指定不同的转换系统（如hepburn、kunrei、nihon）。

示例：

$ echo "ローマ字変換プログラム作ってみた。" | cutlet
Roma ji henkan program tsukutte mita.

Python代码集成

在Python脚本中使用Cutlet，首先要导入模块并初始化对象：

import cutlet
katsu = cutlet.Cutlet()

# 输出罗马字
print(katsu.romaji("カツカレーは美味しい"))
# 结果: 'Cutlet curry wa oishii'

# 切换到slug模式，适合URL生成
print(katsu.slug("カツカレーは美味しい"))
# 结果: 'cutlet-curry-wa-oishii'

# 关闭外来词拼写特性
katsu.use_foreign_spelling = False
print(katsu.romaji("カツカレーは美味しい"))
# 结果: 'Katsu karee wa oishii'

支持不同罗马字系统：

katu = cutlet.Cutlet('kunrei')
print(katu.romaji("富士山"))  # 结果: 'Huzi yama'

API使用文档

初始化Cutlet实例

cutlet_instance = cutlet.Cutlet(system='hepburn')  # 可选系统类型

主要方法

• .romaji(text)：将日文文本转换为罗马字。
• .slug(text)：将文本转换为适用于URL的slug形式。
• 属性调整，比如.use_foreign_spelling = False以关闭特定拼写规则。

项目安装方式（重申）

安装Cutlet的基本步骤已在“安装指南”部分提及，关键在于使用pip执行以下命令，并考虑MeCab词典的兼容性。具体操作如下：

• 仅Cutlet安装：pip install cutlet
• 同时安装必要的词典库：pip install unidic-lite

通过遵循上述指南，您将能够充分利用Cutlet的功能，无论是进行简单的罗马字转换还是更高级的应用，如网址生成等。记得访问官方文档以获取最新信息和更详细的示例。

cutlet 项目地址: https://gitcode.com/gh_mirrors/cu/cutlet