pdf_oxide

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• macOS / Linux，并已安装 Homebrew（README 给出的 brew 安装方式）
• Python 3 环境（如需使用 Python 绑定 from pdf_oxide import PdfDocument）
• Rust 工具链（如需从源码执行 cargo test）
• 一个待处理的 PDF 文件（示例中为 paper.pdf）

安装与启动步骤

1. 1用 brew 安装

   通过 Homebrew tap 安装 pdf-oxide，该安装包同时包含 pdf-oxide-mcp（供 AI 助手使用的 MCP 服务）。

   brew install yfedoseev/tap/pdf-oxide

   复制

2. 2准备 Python 绑定

   README 的 Installation 章节为空，只演示了 Python 导入用法，未给出 pip 安装命令，请按官网 oxide.fyi 或仓库说明安装后再调用。

3. 3运行 Python 示例

   用上下文管理器打开一份 PDF（示例为 paper.pdf），读取文档并打印页数，确认绑定可用。

   from pdf_oxide import PdfDocument
   
   with PdfDocument("paper.pdf") as doc:
       print(len(doc))

   复制

4. 4从源码跑测试

   克隆仓库后进入项目根目录执行 cargo test，验证 Rust 核心功能是否正常。

   git clone https://github.com/yfedoseev/pdf_oxide.git
   cd pdf_oxide
   cargo test

   复制

如何确认成功

brew 安装无报错；cargo test 通过；Python 中能用 PdfDocument 打开 PDF 并打印出页数。

常见问题

注意事项

• README 的 Installation 章节内容为空，Python 侧安装命令缺失，请以官方仓库/官网为准。
• brew 安装的是 CLI 与 MCP 服务，语言绑定（Python 等）属于另外的集成方式。
• 项目处于早期阶段，当前版本为 v0.3.69，接口可能变动。
• 项目信息标注 MIT 与 Apache-2.0 双许可，README 正文写作 MIT，商用前建议再确认 LICENSE 文件。