PyGlossary 技术文档

1. 安装指南

系统要求

PyGlossary 需要 Python 3.10 或更高版本，并且适用于几乎所有现代操作系统。虽然主要为 GNU/Linux 设计，但它也支持 Windows、Mac OS X 和其他基于 Unix 的操作系统。

安装步骤

在 Windows 上安装

1. 下载并安装 Python：访问 Python 官方网站 下载并安装 Python 3.10 或更高版本。
2. 打开命令提示符：点击开始菜单，输入“命令提示符”，右键点击并选择“以管理员身份运行”。
3. 确保 pip 已安装：运行以下命令以确保 pip 已安装并更新：

   python -m ensurepip --upgrade
   

4. 安装 PyGlossary：运行以下命令以安装 PyGlossary：

   pip install --upgrade pyglossary
   

5. 验证安装：安装完成后，您应该能够通过命令行运行 pyglossary 命令。如果命令未找到，请确保 Python 的环境变量已正确设置。

在 Linux 上安装

1. 安装依赖：根据您的发行版，安装所需的依赖包。例如：
   • Debian/Ubuntu：

     sudo apt install python3-gi python3-gi-cairo gir1.2-gtk-3.0
     

   • Fedora：

     sudo dnf install pygobject3 python3-gobject gtk3
     

2. 安装 PyGlossary：运行以下命令以安装 PyGlossary：

   pip install --upgrade pyglossary
   

在 Mac OS X 上安装

1. 安装依赖：使用 Homebrew 安装所需的依赖包：

   brew install pygobject3 gtk+3
   

2. 安装 PyGlossary：运行以下命令以安装 PyGlossary：

   pip install --upgrade pyglossary
   

2. 项目的使用说明

用户界面选择

PyGlossary 提供了多种用户界面类型，您可以根据需要选择合适的界面：

• Gtk3-based 界面：使用 PyGI 和 Gtk3，适用于大多数 Linux 发行版。
• Tkinter-based 界面：适用于 Windows 和没有 Gtk 的环境。
• 命令行界面：适用于所有操作系统，无需任何特定要求。
• 交互式命令行界面：适用于移动设备（如 Android 上的 Termux），无需 GUI。
• Web 界面：通过 HTTP 服务器在浏览器中打开。

界面选择命令

您可以通过 --ui 参数明确选择用户界面类型：

• ./main.py --ui=gtk
• ./main.py --ui=gtk4
• ./main.py --ui=tk
• ./main.py --ui=web
• ./main.py --ui=cmd

3. 项目API使用文档

支持的格式

PyGlossary 支持多种格式的词典文件转换，具体支持的格式如下：

格式	扩展名	读取	写入
Aard 2 (slob)	.slob	✔	✔
ABBYY Lingvo DSL	.dsl	✔
Almaany.com (SQLite3, Arabic)	.db	✔
AppleDict Binary	.dictionary	✔	❌
AppleDict Source			✔
Babylon BGL	.bgl	✔	❌
cc-kedict (Korean)		✔	❌
CSV	.csv	✔	✔
Dict.cc (SQLite3, German)	.db	✔
DICT.org / Dictd server	(📝.index)	✔	✔
DICT.org / dictfmt source	(.dtxt)		✔
dictunformat output file	(.dictunformat)	✔
DictionaryForMIDs	(📁.mids)	✔	✔
DigitalNK (SQLite3, N-Korean)	.db	✔
DIKT JSON	(.json)		✔
EDICT2 (CEDICT) (Chinese)	(.u8)	✔	❌
EDLIN	.edlin	✔	✔
EPUB-2 E-Book	.epub	❌	✔
FreeDict	.tei	✔	❌
Gettext Source	.po	✔	✔
HTML Directory (by file size)		❌	✔
JMDict (Japanese)		✔	❌
JSON	.json		✔
Kobo E-Reader Dictionary	.kobo.zip	❌	✔
Kobo E-Reader Dictfile	.df	✔	✔
Lingoes Source	.ldf	✔	✔
Mobipocket E-Book	.mobi	❌	✔
Octopus MDict	.mdx	✔	❌
QuickDic version 6	.quickdic	✔	✔
SQL	.sql	❌	✔
StarDict	(📝.ifo)	✔	✔
StarDict Textual File	.xml	✔	✔
Tabfile	.txt, .tab	✔	✔
Wiktextract	.jsonl	✔
Wordset.org		✔
XDXF	.xdxf	✔	❌
Yomichan	.zip		✔
Zim (Kiwix)	.zim	✔

注意事项

• SQLite 格式的文件不会通过扩展名（.db）自动检测，因此您需要通过 UI 或 --read-format 标志选择格式。
• 不要将 SQLite 格式的文件与 SQLite 模式 混淆。

4. 项目安装方式

通过 pip 安装

您可以通过 pip 安装 PyGlossary：

pip install --upgrade pyglossary

从源码安装

1. 克隆仓库：

   git clone https://github.com/ilius/pyglossary.git
   

2. 进入项目目录：

   cd pyglossary
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 运行项目：

   python main.py
   

通过以上步骤，您可以成功安装并使用 PyGlossary 进行词典文件的转换。