Metadata-Version: 2.4
Name: rimetool
Version: 2.4.3
Summary: Rime输入法相关工具集，支持词库转换、通讯录导入等功能
License: Rimetool 专有软件许可协议 (Proprietary Software License)
        
        版权所有 (c) 2025 whitewatercn 保留所有权利。
        
        重要提示
        - 使用本软件（包括但不限于获取、安装、运行、复制、修改、编译、分发、再许可、通过云/托管/软件即服务方式提供访问、以及任何直接或间接的商业使用）前，必须取得版权所有者的书面许可。未获得书面许可的，任何用途均被禁止。
        
        许可授予
        - 在您与版权所有者签署的书面许可/合同明确约定的范围、地域与期限内，您可依许可文件的具体条款使用本软件。
        - 任何未在书面许可中明示授予的权利，均由版权所有者保留。
        
        禁止性条款（无书面许可即适用）
        - 未经书面许可，禁止：
          1) 使用、复制、修改、合并、编译或以任何方式基于本软件创作衍生作品；
          2) 以任何形式向第三方提供本软件（包括但不限于分发、传播、出借、出租、转让、再许可，或通过 API/网络/云服务向公众提供访问）；
          3) 将本软件用于任何商业或生产用途；
          4) 对本软件进行反编译、反汇编、逆向工程或以其他方式试图获取源代码，法律强制允许的范围除外；
          5) 移除或更改任何权利声明、标识或许可信息；
          6) 将本软件用于任何违法或侵权用途。
        
        知识产权与第三方组件
        - 本软件及其全部副本的知识产权归版权所有者所有并受法律保护。
        - 本软件可能包含第三方开源或专有组件，相关组件的使用须遵守其各自的许可条款；如该等条款与本协议存在冲突，以该第三方许可条款为准于相应组件的使用范围内。
        
        免责声明
        - 本软件按“现状”提供，不附带任何明示或默示的担保，包括但不限于适销性、特定用途适用性及非侵权的默示担保。您对使用本软件所产生的一切风险自行承担。
        
        责任限制
        - 在适用法律允许的最大范围内，任何情况下，版权所有者及其贡献者均不对因使用或无法使用本软件而产生的任何损害承担责任（包括但不限于利润损失、业务中断、数据丢失或其他经济损失），即使其已被告知可能发生此类损害。
        
        终止
        - 如您违反本协议任何条款或未遵守适用的书面许可，本协议项下授予您的任何权利将自动终止，且无须另行通知。终止后，您应立即停止一切使用并销毁本软件及其全部副本。
        
        适用法律与争议解决
        - 除非另有书面约定，本协议受您主要营业地或居住地所在地的法律管辖，不适用其法律冲突规则。与本协议有关的任何争议，由版权所有者所在地有管辖权的法院专属管辖。
        
        许可与商务合作联系
        - 如需获取使用、开发或商业授权，请联系我们。
        
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: argparse>=1.4.0
Requires-Dist: chardet>=5.2.0
Requires-Dist: click>=8.2.1
Requires-Dist: flask>=3.1.2
Requires-Dist: flask-cors>=6.0.1
Requires-Dist: jieba>=0.42.1
Requires-Dist: pypinyin>=0.55.0
Requires-Dist: zipp>=3.23.0
Dynamic: license-file

# Rimetools

一些rime使用工具

| 使用                                                    | 功能简介                                                                 |
| ------------------------------------------------------- | ------------------------------------------------------------------------ |
| rimetool --input-path 你的文件路径 --tool vcf           | 用于将联系人文件（.vcf）导出为rime词库                                   |
| rimetool --input-path 你的文件路径 --tool singleword    | 将单个词（如hello）或单个词组（如hello world）文件（.txt）导出为rime词库 |
| rimetool --input-path 你的文件路径 --tool singlechinese | 将单个中文词组（如你好）文件（.txt）导出为rime词库                       |
| rimetool --input-path 你的文件路径 --tool tosougou      | 将rime词库导出为搜狗txt词库                                              |

# 安装

```
pip install rimetool
```

# 使用

⚠️请查看 `examples`中相关示例文件，确保自己的原始文件符合rimetool的需求才可以转换

以 `examples/contacts.vcf`为例，这是macOS导出的通讯录，我们希望将其中的名字转换成rime词库，从而实现某些国产输入法导入通讯录的功能

其内容如下，转换前请确认你的vcf文件格式与之相符

```
BEGIN:VCARD
VERSION:3.0
PRODID:-//Apple Inc.//macOS 14.5//EN
N:apple;;;;
FN:apple
TEL;type=pref:4006668800
END:VCARD
BEGIN:VCARD
VERSION:3.0
PRODID:-//Apple Inc.//macOS 14.5//EN
N:hello;world;;;
FN:world hello
item1.EMAIL;type=INTERNET;type=pref:helloworld@hello.world
item1.X-ABLabel:_$!<Other>!$_
EMAIL;type=INTERNET;type=HOME:hello@world.hello
END:VCARD
BEGIN:VCARD
VERSION:3.0
PRODID:-//Apple Inc.//macOS 14.5//EN
N:你;好;;;
FN:好 你
EMAIL;type=INTERNET;type=pref:123456@qq.com
TEL;type=IPHONE;type=CELL;type=VOICE;type=pref:10086
END:VCARD
```

在终端执行

```
> rimetool --input-path examples/contacts.vcf --tool vcf
已生成文件 /Users/ww/coding/mytools/rimetool_github/contact_output.dict.yaml
```

其内容为

```
# 生成工具 https://github.com/B-Beginner/rimetools
# 生成时间 2024-06-13_16-03-02
---
apple	apple	1
helloworld	helloworld	1
你好	nihao	1
```

这样，你就得到了这份vcf通讯录文件中的人名的词库了，快快导入你的rime中吧！

# 部署本项目

本项目通过[uv](https://docs.astral.sh/uv/)管理包依赖及虚拟环境，使用非常简单（[点击查看教程](https://forum.beginner.center/t/topic/2137))，下载仓库后，在仓库所在路径运行下方代码，就大功告成了🤟

```
pip install uv #安装uv
uv init #初始化uv
uv sync #通过uv安装本项目所需的全部依赖
```

# 文件结构

```.
├── README.md
├── examples #示例文件
├── rimetool #核心代码
│   ├── __init__.py
│   ├── epub #epub相关功能核心代码
│   ├── main.py #读取用户输入的输入输出路径，选择转换工具，启用utils下的各类转换工具
│   └── utils #各类转换工具的核心代码
└── setup.py #pypi相关配置文件
```

# 感谢

[manateelazycat](https://manateelazycat.github.io/)：作为开源过来人提供了思想上的帮助

[JyiDeng](https://github.com/JyiDeng)：核心开发者

# 更多

[中州韵助手](https://github.com/yanhuacuo/rimetool)：一款rime可视化配置工具，很巧也叫rimetool
