Anki Dict Helper 使用教程

Anki Dict Helper 使用教程

1. 项目的目录结构及介绍

Anki Dict Helper 项目的目录结构如下：

anki-dict-helper/
├── README.md
├── src/
│   ├── main.py
│   ├── config.json
│   └── utils/
│       ├── helper.py
│       └── parser.py
└── tests/
    ├── test_main.py
    └── test_utils.py

目录结构介绍

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• src/: 源代码目录，包含项目的主要代码文件。
  • main.py: 项目的启动文件。
  • config.json: 项目的配置文件。
  • utils/: 工具模块目录，包含辅助函数和解析器。
    • helper.py: 辅助函数模块。
    • parser.py: 解析器模块。
• tests/: 测试代码目录，包含项目的测试文件。
  • test_main.py: 针对 main.py 的测试文件。
  • test_utils.py: 针对 utils/ 目录下文件的测试文件。

2. 项目的启动文件介绍

main.py

main.py 是 Anki Dict Helper 项目的启动文件，负责初始化配置、加载插件和启动主程序。以下是 main.py 的主要功能：

• 读取 config.json 配置文件。
• 初始化插件环境。
• 启动主程序循环，监听用户操作。

代码示例

import json
from utils.helper import init_plugin

def main():
    # 读取配置文件
    with open('config.json', 'r') as f:
        config = json.load(f)
    
    # 初始化插件
    init_plugin(config)
    
    # 启动主程序
    start_main_loop()

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

config.json

config.json 是 Anki Dict Helper 项目的配置文件，包含插件运行所需的各种配置参数。以下是 config.json 的主要内容：

• dictionary: 使用的词典配置。
• anki: Anki 连接配置。
• user: 用户自定义设置。

配置示例

{
    "dictionary": {
        "name": "Oxford",
        "url": "https://www.oxforddictionaries.com"
    },
    "anki": {
        "host": "127.0.0.1",
        "port": 8765
    },
    "user": {
        "language": "en",
        "theme": "light"
    }
}

配置文件说明

• dictionary: 指定使用的词典名称和 URL。
• anki: 指定 Anki 连接的主机和端口。
• user: 用户自定义的语言和主题设置。

通过以上配置，Anki Dict Helper 可以根据用户的需求进行个性化设置，提升学习效率。