Tarkesh2shar

介绍

Tarkesh2shar 是一个基于 Python 开发的模块，旨在提供从波斯文（Farsi/Persian）转化为英文转写（Transliteration）的支持。

这个模块是基于不同的转写规则和算法开发的，包括 ISO， ITRANS 和 Harvard-Kyoto 等，能够满足不同的转写需求。

安装

您可以使用 pip 命令来安装这个模块：

pip install tarkesh2shar

使用

转换方法

要使用 Tarkesh2shar 进行转换，您需要使用 Converter 类：

from tarkesh2shar import Converter

converter = Converter()
result = converter.convert('سلام')
print(result)

这个例子将波斯文的 "سلام" 转换为 "salaam"。

转写规则

Converter 类支持多个转写规则，您可以通过指定 to 参数来切换。例如：

from tarkesh2shar import Converter

converter = Converter(to='itrans')
result = converter.convert('سلام')
print(result)

这个例子将波斯文的 "سلام" 转换为 ITRANS 转写。

目前支持的规则包括：

• iso
• itrans
• hk
• velthuis
• wx

高级选项

您可以通过 Converter 类的 options 参数来指定一些高级选项，其中包含：

• reverse: 是否对转换结果进行反向操作（默认为 False）；
• unknown: 在无法转换某个字符时的替换字符（默认为 '?'）；
• combine: 是否将连续的多个元音字符合并为一个字符（默认为 False）。

例如：

from tarkesh2shar import Converter

converter = Converter(to='hk', options={'combine': True})
result = converter.convert('سلام')
print(result)

这个例子将波斯文的 "سلام" 使用 Harvard-Kyoto 规则转换，并合并连续的多个元音字符。

作者

Tarkesh2shar 由 Ali Doustkani 开发和维护。

贡献

欢迎您为 Tarkesh2shar 做出贡献，您可以：

• 在 GitHub 上提交问题和反馈；
• 贡献代码并进行自测；
• 参与文档编写和维护；
• 在社交媒体上分享 Tarkesh2shar 的使用和介绍。

许可证

Tarkesh2shar 是基于 MIT 许可证开源的。请在使用本库前先阅读许可证文件。