PDF2HTML_Samples

目的是对比一下常用的 PDF 转 HTML/XML 的工具。

整个对比过程放在了 Github 仓库中，
欢迎提交 PR/Issue 补充更多工具：https://github.com/shandianchengzi/PDF2HTML_Samples。

对比结果同步更新在 CSDN 博客中，目录页在博客 【记录】Python3｜2024年 PDF 转 XML 或 HTML 的第三方库的使用方式、测评过程以及对比结果（汇总）。

整个测评流程由 @汐琐_ayq618258 （Github 账号：arche8） 学妹和我（Github账号：shandianchengzi）一起完成，我主要是写了测评的流程并搭了框架，学妹补充了各项工具的测评代码和结果。感谢学妹！

1 测评过程

1. 运行本仓库根目录下的 tools.py 文件，新建测试目录和测试文件：

   python3 tools.py new pdfminer.six       # 新建 pdfminer.six 工具测试目录 `python_samples/test_pdfminer_six`
   python3 tools.py new pdfminer.six html  # 新建 pdfminer.six 工具的转换为 HTML 的测试文件 `python_samples/test_pdfminer_six/to_html.py`
   

2. 测试新工具的时候只需要重写新生成的测试文件的 convert_pdf_to_{format} 这个函数的内容，其他的我全部写好了。
   1. 写测试函数的时候：
      • 如果参考了网络上的内容，在测试文件的上方填写一下 # Reference: 链接；
      • 如果工具的安装方式并非使用 pip install [工具名] 安装，将测试文件上方的 need_pip_install = True 改完 need_pip_install = False。
   2. 如果一个工具有多种写法，选结果最好的一种生成在 output 下。其他的已经写好的也不用删掉，可以注释了放一边。
   3. 如果写的时候调用了除了工具名以外的其他第三方库，添加到 requirements.txt 中，以便之后我们同步更新时可以通过 pip install -r requirements.txt 装好对方的依赖。
3. 写好函数之后，测试的方法：

   python3 tools.py test pdfminer.six       # 测试 pdfminer.six 工具下的所有格式转换文件
   python3 tools.py test pdfminer.six html  # 测试 pdfminer.six 工具的转换为 HTML 的测试文件
   

具体测试过程是调用 python_sampls/test_framework.py。
工具完整功能详见 tools.py 文件。

测试输出：输出的文件在当前测评的工具的文件夹下，并被命名为 to_{format}_{pdf_name}.{format}。例如 pdfminer.six 工具样例的输出，放到 python_samples/test_pdfminer_six/outputs 。

2 评估方式

这个评估方式写得很笼统，具体如何大家可以自行查看测评结果。

1. 能分清 PDF 章节
2. 具备嵌套标签（就是格式化之后能看出来有树状 DOM 元素的效果）
3. 统计一下各个工具的社区活跃度（开源的看 Star 数量和最后更新的时间）

3 结果说明

1. 修改 README.md，用符号简单标注一下工具好不好用。可用的符号：❌✅⭐✨。
   1. 完全用不了就打叉❌
   2. 用得了就✅
   3. 推荐指数⭐⭐⭐⭐⭐
   4. 如果你觉得这个工具很nb就✨
2. 详细说明可写在 results/{工具名称}.md 下。

4 测评列表

在Python中，有几个开源工具可用于将PDF文件转换为XML或HTML格式。以下是其中一些：

序号	工具名	网传描述	测试结果
1	pdfminer	Warning: Starting from version 20191010, PDFMiner supports Python 3 only. For Python 2 support, check out pdfminer.six. https://pypi.org/project/pdfminer/
2	pdfminer.six	【这个工具是专供 Python2 的，详见 https://pypi.org/project/pdfminer/ 】这是一个PDF文档解析器，可以用于提取文本、元数据以及页面布局信息。您可以使用pdfminer.six来提取PDF中的文本内容，并将其转换为XML或HTML格式。	不太好用，详见【记录】Python3｜ 将 PDF 转换成 HTML/XML（✅⭐pdfminer.six）
3	pdfminer3k	据说是 pdfminer 的 Python3 版本，不清楚和 pdfminer.six 有什么区别。
4	PyPDF2	这是一个纯Python库，用于处理PDF文件。虽然主要用于创建、阅读和修改PDF文件，但您也可以使用它来提取文本内容，并将其转换为XML或HTML格式。
5	pdf2xml	这是一个命令行工具，可以将PDF文件转换为XML格式。虽然它不是Python库，但您可以通过Python的subprocess模块来调用该工具，并处理生成的XML文件。
6	pdf2htmlEX	这是另一个命令行工具，用于将PDF文件转换为HTML格式。您可以通过Python的subprocess模块来调用该工具，并处理生成的HTML文件。https://blog.csdn.net/gitblog_00074/article/details/136775457	✅⭐⭐⭐⭐pdf2htmlEX：除了大纲有点问题，其他都很好。它还提供了很多转换参数https://github.com/coolwanglu/pdf2htmlEX/wiki/Command-Line-Options
7	PyMuPDF+tqdm	https://blog.csdn.net/qq_28505809/article/details/124147552	✅⭐PyMuPDF+tqdm：和pdfminer.six转换结果类似
8	PDFQuery	https://www.freecodecamp.org/chinese/news/extract-data-from-pdf-files-with-python	✅⭐PDFQuery：不好，和pdfminer.six转换结果类似
9	Spire.PDF	https://blog.csdn.net/eiceblue/article/details/135988859, https://www.e-iceblue.com/Tutorials/Python/Spire.PDF-for-Python/Program-Guide/Conversion/Python-Convert-PDF-to-HTML.html	✅⭐⭐⭐Spire.PDF：还行，就是转换参数太少，并且试用会有水印，最多只能转化10页
10	pdfkit	Adobe 提到了这个库，但是有人说是 iOS 专用的，StackOverflow 上只找到这个：https://stackoverflow.com/questions/75757120/convert-pdf-to-html-using-python-and-pdfkit
11	pdftotree	本软件包是我们开发自己的模块以替代 Adobe Acrobat 的成果。目前有几种将 pdf 转换为 html 的开源工具，但这些工具无法保留表格中的单元格结构。我们在这个项目中的目标是开发一个工具，提取 pdf 文档中的文本、数字和表格，并以易于使用的格式返回。https://pypi.org/project/pdftotree/	✅⭐⭐pdftotree：能转换但效果不太好，去除了很多格式
12	depdf	An ultimate pdf file disintegration tool. DePDF is designed to extract tables and paragraphs into structured markup language [eg. html] from embedding pdf pages. You can also use it to convert page/pdf to html. Built on top of pdfplumber. https://pypi.org/project/depdf/0.1.1/	✅⭐⭐depdf：能转换但效果不太好，去除了很多格式，和pdftotree类似，都不太能很明显的分清PDF的各个章节
13	poppdf	A python (3.6+) module that wraps poppler’s pdftoimage, pdftohtml and pdftotext to extract informations from PDF. https://pypi.org/project/poppdf/
14	pandoc	pandoc input.pdf -o output.html	❌【已测，失败】pandoc 不接受 pdf 这个输入。详见 【记录】Pandoc｜Linux安装最新Pandoc。

如果还有其他工具也可以尝试测试并添加进来。

---

后续会持续更新更详细的使用方式、测评过程和结果，会在这篇文章里增加博客链接以及描述，与 Github 仓库保持一致。