PdfItDown 项目使用教程

PdfItDown 项目使用教程

PdfItDown Convert Everything to PDF 项目地址: https://gitcode.com/gh_mirrors/pd/PdfItDown

1. 项目目录结构及介绍

PdfItDown 项目是一个用于将多种文件格式转换为 PDF 的 Python 包。项目目录结构如下：

PdfItDown/
├── .github/             # GitHub 工作流文件
├── img/                 # 图片资源
├── src/                 # 源代码目录
│   └── pdfitdown/       # PdfItDown 包目录
├── tests/               # 测试代码目录
├── .gitignore           # Git 忽略文件
├── CONTRIBUTING.md      # 贡献指南
├── LICENSE              # 许可证文件
├── README.md            # 项目说明文件
├── pyproject.toml       # 项目配置文件
└── requirements.txt     # 项目依赖文件

• .github/：包含 GitHub Actions 工作流文件，用于自动化项目的一些操作。
• img/：存放项目相关图片资源。
• src/：源代码目录，包含 PdfItDown 包。
• tests/：测试代码目录，用于确保代码质量。
• .gitignore：指定 Git 忽略的文件和目录。
• CONTRIBUTING.md：贡献指南，说明如何为项目贡献代码。
• LICENSE：项目使用的 MIT 许可证。
• README.md：项目说明文件，介绍项目的基本信息和如何使用。
• pyproject.toml：项目配置文件，用于定义项目元数据和依赖。
• requirements.txt：项目依赖文件，列出项目所需的 Python 包。

2. 项目的启动文件介绍

PdfItDown 项目没有特定的启动文件。项目主要通过命令行工具 pdfitdown 和 Python API 来使用。

命令行工具

使用 pdfitdown 命令行工具可以将文件转换为 PDF。安装项目后，可以通过以下方式使用：

pdfitdown -i INPUTFILE -o OUTPUTFILE [-t TITLE]

• -i INPUTFILE：指定输入文件路径。
• -o OUTPUTFILE：指定输出 PDF 文件路径。
• -t TITLE：可选，指定 PDF 文件的标题。

Python API

也可以在 Python 脚本中使用 PdfItDown 的 API 来转换文件。

from pdfitdown.pdfconversion import Converter

converter = Converter()
converter.convert(file_path="example.md", output_path="example.pdf", title="Example PDF")

3. 项目的配置文件介绍

PdfItDown 项目的配置主要通过 pyproject.toml 文件进行。

pyproject.toml 文件示例：

[tool.pdfitdown]
version = "1.2.0"
description = "Convert Everything to PDF"
authors = [
    "AstraBert <astrabert@example.com>"
]
dependencies = [
    "markdown_pdf",
    "img2pdf",
]

这个配置文件定义了项目的元数据和依赖。version 指定了项目的版本号，description 是项目的简短描述，authors 列出了项目作者的信息，dependencies 列出了项目依赖的 Python 包。

PdfItDown Convert Everything to PDF 项目地址: https://gitcode.com/gh_mirrors/pd/PdfItDown