Calibre 开源项目使用教程

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

Calibre 项目的目录结构如下：

calibre/
├── AUTHORS.txt
├── CHANGELOG.txt
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
├── appveyor.yml
├── calibre
│   ├── __init__.py
│   ├── __main__.py
│   ├── ...
├── calibre.spec
├── dev-requirements.txt
├── setup.py
├── src
│   ├── calibre
│   │   ├── __init__.py
│   │   ├── __main__.py
│   ├── ...
├── third-party
│   ├── ...
├── tools
│   ├── ...
└── ...

主要目录和文件介绍：

• calibre/: 主项目目录，包含主要的 Python 代码。
• AUTHORS.txt: 项目贡献者列表。
• CHANGELOG.txt: 项目更新日志。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• Dockerfile: Docker 镜像构建文件。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包清单文件。
• Makefile: 编译和构建脚本。
• README.md: 项目说明文档。
• appveyor.yml: AppVeyor CI 配置文件。
• calibre.spec: RPM 包构建配置文件。
• dev-requirements.txt: 开发依赖文件。
• setup.py: 安装脚本。
• src/: 源代码目录。
• third-party/: 第三方库目录。
• tools/: 工具脚本目录。

2. 项目的启动文件介绍

Calibre 项目的启动文件是 calibre/__main__.py。这个文件是 Calibre 应用程序的入口点，负责启动整个应用程序。

# calibre/__main__.py

import sys
from calibre.gui2.main import main

if __name__ == '__main__':
    main()

主要功能：

• 导入 calibre.gui2.main 模块中的 main 函数。
• 检查当前模块是否为主模块，如果是，则调用 main 函数启动应用程序。

3. 项目的配置文件介绍

Calibre 项目的配置文件主要位于用户主目录下的 .config/calibre 目录中。这些配置文件包括：

• global.py: 全局配置文件，包含应用程序的全局设置。
• preferences.txt: 用户偏好设置文件，包含用户的个性化设置。
• plugins: 插件目录，包含用户安装的插件。

主要配置文件介绍：

• global.py:

# global.py

{
    "debug_log": "",
    "jobs": [],
    "main_init_completed": true,
    "new_version_notifications": true,
    "plugins": {},
    "program_driver": "calibre.gui2.main.MainWindow",
    "user_css": {}
}

• preferences.txt:

# preferences.txt

{
    "add_formats": [],
    "auto_register_device": true,
    "autorotate_images": false,
    "check_for_updates": true,
    "column_map": {},
    "confirm_delete": true,
    "database_metadata_cache_size": 100,
    "default_send_to_device_action": "books",
    "disable_tray_notification": false,
    "edit_metadata_by_default": false,
    "enforce_cpu_limit": false,
    "extra_css": "",
    "extra_options": {},
    "file_icon_rules": [],
    "gui_layout": "default",
    "hide_tool_bar": false,
    "highlight_search_matches": true,
    "install_fonts": false,
    "jobs_per_core": 1,
    "language": "zh_CN",
    "letter_spacing": 0,
    "line_spacing": 1.2,